Brands
List brands
List the brands an API key can read, oldest first, each with the stored scores of its latest completed tracking run.
HTTP
GET https://api.ranqo.ai/v1/brandsThe brands this key reads, oldest first. A key restricted to some brands lists only those.
Query parameters
Every parameter is optional. A parameter the endpoint does not take is refused with unknown_parameter.
| Name | Type | Default | Description |
|---|---|---|---|
limit | integer | 50 | Items per page, 1 to 100. |
cursor | string | The next_cursor of the previous page. |
Response
The response body, as JSON.
| Field | Type | Description |
|---|---|---|
data | array of objects | |
data[].id | string | |
data[].name | string | |
data[].slug | string | The brand's path segment in the dashboard. |
data[].domain | string | |
data[].domain_aliases | array of strings | Other domains the brand owns. |
data[].category | string or null | |
data[].description | string or null | |
data[].location | string or null | The market the brand targets, as entered. |
data[].reach | string or null | One of worldwide, country, local. |
data[].language | string or null | ISO 639-1 code; null means English. |
data[].platforms | array of strings | The engines tracked for this brand. |
data[].is_tracking_paused | boolean | |
data[].created_at | string | RFC 3339 timestamp in UTC. |
data[].latest_run | object or null | Scores stored on the run itself when it completed. The latest completed run; null before the first. |
data[].latest_run.id | string | |
data[].latest_run.completed_at | string | RFC 3339 timestamp in UTC. |
data[].latest_run.platforms | array of strings | The engines the run asked. |
data[].latest_run.visibility | number or null | The run's own stored visibility, 0-100, one decimal. |
data[].latest_run.average_position | number or null | The average position when named, one decimal; null when never named. |
has_more | boolean | Whether another page follows. |
next_cursor | string or null | Pass as cursor for the next page; null on the last page. |
Response headers
| Header | Description |
|---|---|
X-Request-Id | The request id; quote it to support. |
RateLimit | Requests left in this window and seconds until it resets. |
RateLimit-Policy | The key's limit per window. |
Example request
curl
curl "https://api.ranqo.ai/v1/brands" \
-H "Authorization: Bearer $RANQO_API_KEY"Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.