Brands
List brands
List the brands an API key can read, oldest first, each with the stored scores of its latest completed tracking run.
/v1/brandsThe brands this key reads, oldest first. A key restricted to some brands lists only those.
Authorization
AuthorizationstringheaderrequiredYour API key as Bearer ranqo_sk_…. The account owner creates keys in Settings, under API keys. See Authentication.
Query parameters
Every parameter is optional. A parameter the endpoint does not take is refused with unknown_parameter.
limitintegerdefault: 50Items per page, 1 to 100.
Range: 1 ≤ x ≤ 100
cursorstringThe next_cursor of the previous page.
curl "https://api.ranqo.ai/v1/brands" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
The response body, as JSON.
dataarray of objectsShow 14 fields insideHide the fields inside
idstringnamestringslugstringThe brand's path segment in the dashboard.
domainstringdomain_aliasesarray of stringsOther domains the brand owns.
categorystring or nulldescriptionstring or nulllocationstring or nullThe market the brand targets, as entered.
reachstring or nullOne of
worldwide,country,local.languagestring or nullISO 639-1 code; null means English.
platformsarray of stringsThe engines tracked for this brand.
is_tracking_pausedbooleancreated_atstringRFC 3339 timestamp in UTC.
latest_runobject or nullScores stored on the run itself when it completed. The latest completed run; null before the first.
Show 5 fields insideHide the fields inside
idstringcompleted_atstringRFC 3339 timestamp in UTC.
platformsarray of stringsThe engines the run asked.
visibilitynumber or nullThe run's own stored visibility, 0-100, one decimal.
average_positionnumber or nullThe average position when named, one decimal; null when never named.
has_morebooleanWhether another page follows.
next_cursorstring or nullPass as
cursorfor the next page; null on the last page.
Response headers
X-Request-IdThe request id; quote it to support.
RateLimitRequests left in this window and seconds until it resets.
RateLimit-PolicyThe key's limit per window.
Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.