APIReferenceReports

List a brand's report artifacts

List artifacts for a brand. Filters: ?reportType=, ?categoryId=. Response shape (paginator-augmented): { "count": int, "next": url|null, "previous": url|null, "results": ReportArtifact[], "permissions": { "canViewReports": bool, "canGenerate": bool, "canGenerateFreeReport": bool, "hasFreeReport": bool, "reportsReady": bool, "isDemo": bool } } `permissions` is appended to the paginator response so the frontend can render the upsell card (when canViewReports=False) and decide whether to show the Generate cards (canGenerate=False on demo brands or read-only tiers) without a second round-trip.

GET/api/brands/{brand_id}/reports/

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

brand_id*integer

Query Parameters

categoryId?integer

Filter to artifacts scoped to this category (brand-wide artifacts always included).

page?integer

1-based page number.

page_size?integer

Rows per page. Server-side default/cap vary per endpoint.

reportType?string

Filter by report type (accepts type as an alias).

Response Body

application/json

curl -X GET "https://example.com/api/brands/0/reports/"
{  "results": [    {      "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"    }  ],  "permissions": {    "canViewReports": true,    "canGenerate": true,    "canGenerateFreeReport": true,    "hasFreeReport": true,    "reportsReady": true,    "isDemo": true  },  "count": 0,  "next": "string",  "previous": "string"}