APIReferenceReports

Get a report artifact

Single-artifact poll endpoint.

GET/api/reports/{artifact_id}/

Authorization

AuthorizationBearer <token>

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

artifact_id*integer

Response Body

application/json

curl -X GET "https://example.com/api/reports/0/"
{  "id": "string",  "brandId": "string",  "categoryId": "string",  "reportType": "string",  "reportTypeLabel": "string",  "status": "string",  "format": "string",  "createdAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "downloadUrl": "string",  "viewUrl": "string",  "errorMessage": "string",  "agentName": "",  "agentVersion": "",  "costUsd": "string",  "kgGenerationJob": "string",  "evidenceRefsCount": 0,  "isBranded": true,  "abortedReason": "string",  "generatedByEmail": "string"}