Runs
List runs
List a brand's tracking runs, newest first, with each completed run's stored visibility, position and answer counts.
/v1/brands/{brand_id}/runsThe brand's tracking runs, newest first.
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.
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.
statusstringOnly runs in this state.
Options:pendingrunningcompletedfailed
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/runs" \
-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 12 fields insideHide the fields inside
idstringstatusstringOne of
pending,running,completed,failed.platformsarray of stringsThe engines the run asked.
created_atstringRFC 3339 timestamp in UTC.
started_atstring or nullRFC 3339 timestamp in UTC.
completed_atstring or nullRFC 3339 timestamp in UTC.
prompt_countinteger or nullPrompts the run asked; null until it completes.
answer_countinteger or nullAnswers the run's scores count: the successful ones and the filled-in ones. Null until it completes.
failed_countinteger or nullQuestions that failed, filled-in ones included. Null until it completes.
filled_countinteger or nullFailed questions filled in from the same prompt's previous answer; 0 on runs from before filling-in existed. Null until it completes.
visibilitynumber or nullThe run's own visibility, 0-100, fixed when it completed: it counts filled-in answers, and the answers of prompts deleted since. The reports leave both out, so they can differ. Null until it completes.
average_positionnumber or nullThe run's stored average position when named; null until it completes, and when the brand was 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.