Get run status
The four poll-loop fields from run detail — `id`, `status`, `pollUrl`, `finishedAt` — and nothing else. Reads a single run row: no answers, no competitor or source aggregation. This is the endpoint a "is the scan finished?" loop should call.
/api/runs/{run_id}/status/Personal Access Token (create one from Settings -> API Keys in the dashboard). Send as Authorization: Bearer gr_live_.... An X-API-Key: gr_live_... header (see the apiKeyAuth scheme) is accepted as an equivalent alternative — send ONE of the two, not both.
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://example.com/api/runs/0/status/"{ "id": "string", "status": "string", "pollUrl": "string", "finishedAt": "string"}Get run detail GET
Run detail: a PAGE of responses (light shape — no `answerText`; drill into `GET /api/responses/{id}/` for the full text), plus whole-run aggregated competitors and sources. `responses[]` is paged with `?page=N&page_size=M` (default 200, max 500). Walk `responsesNext` until it is null to collect every response in the run; `responsesCount` is the run's full total. `competitors` and `sources` are aggregated over the ENTIRE run on every page, so they do not need to be accumulated across pages. For poll-loop use — just "is this run done yet" — call `GET /api/runs/{id}/status/` instead: same status fields, none of the per-answer work. A run stays hidden until it is either legacy or published (`published_at` set); an unpublished run 404s the same as a nonexistent one.
List a brand's recommendations GET
The brand's full active recommendation set (every proposed recommendation, not just the acted-on subset). Each recommendation includes its rationale (`why`), the suggested action, expected impact, measurement plan, score and score breakdown, and lifecycle timestamps (`implementedAt` is the shipped date). Each also nests `artifacts` — the generated content produced for it, including the full `body` — and `outcomes` — the measured before/after metric values with their baselines. Requires a Pro or higher plan.