Runs
Get a run
Read one tracking run by id: its state, the engines it asked, its counts, and its stored visibility once it completes.
/v1/brands/{brand_id}/runs/{run_id}One run of the brand.
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.
run_idstringrequiredThe run id, from GET /v1/brands/{brand_id}/runs.
curl "https://api.ranqo.ai/v1/brands/BRAND_ID/runs/RUN_ID" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
A tracking run: each tracked prompt asked on each of its engines once.
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.
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.