Brands
Get a brand
Read one brand by id: its domain, market and language, with the stored scores of its latest completed tracking run.
/v1/brands/{brand_id}One brand and its latest completed run.
Authorization
AuthorizationstringheaderrequiredYour API key as Bearer ranqo_sk_…. The account owner creates keys in Settings, under API keys. See Authentication.
Path parameters
brand_idstringrequiredThe brand id, from GET /v1/brands.
curl "https://api.ranqo.ai/v1/brands/BRAND_ID" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
The response body, as JSON.
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.
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.