APIReferenceBrands

Get a brand

Brand detail: visibility score, category/prompt counts, last/next monitored-run timestamps, executive summary, and in-flight-run signals.

GET/api/brands/{brand_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

brand_id*integer

Response Body

application/json

curl -X GET "https://example.com/api/brands/0/"
{  "id": "string",  "name": "string",  "website": "string",  "averageScore": 0,  "previousScore": 0,  "hasScoreData": true,  "categoryCount": 0,  "promptCount": 0,  "monitoredPromptCount": 0,  "recCount": 0,  "lastActivity": "string",  "status": "string",  "hasInFlightRun": true,  "runInFlightProgress": {    "property1": null,    "property2": null  },  "monitoringRefreshInProgress": true,  "mergedInto": {    "property1": null,    "property2": null  },  "mergedAt": "string",  "orgId": "string",  "orgName": "string",  "executiveSummary": "string",  "executiveSummaryUpdatedAt": "string",  "lastMonitoredRunAt": "string",  "nextMonitoredRunAt": "string",  "nextRunPromptCount": 0}