Brands
Get a brand
Read one brand by id: its domain, market and language, with the stored scores of its latest completed tracking run.
HTTP
GET https://api.ranqo.ai/v1/brands/{brand_id}One brand and its latest completed run.
Path parameters
| Name | Type | Description |
|---|---|---|
brand_id | string | The brand id, from GET /v1/brands. |
Response
The response body, as JSON.
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
slug | string | The brand's path segment in the dashboard. |
domain | string | |
domain_aliases | array of strings | Other domains the brand owns. |
category | string or null | |
description | string or null | |
location | string or null | The market the brand targets, as entered. |
reach | string or null | One of worldwide, country, local. |
language | string or null | ISO 639-1 code; null means English. |
platforms | array of strings | The engines tracked for this brand. |
is_tracking_paused | boolean | |
created_at | string | RFC 3339 timestamp in UTC. |
latest_run | object or null | Scores stored on the run itself when it completed. The latest completed run; null before the first. |
latest_run.id | string | |
latest_run.completed_at | string | RFC 3339 timestamp in UTC. |
latest_run.platforms | array of strings | The engines the run asked. |
latest_run.visibility | number or null | The run's own stored visibility, 0-100, one decimal. |
latest_run.average_position | number or null | The average position when named, one decimal; null when never named. |
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/BRAND_ID" \
-H "Authorization: Bearer $RANQO_API_KEY"Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.