Skip to main content
GET
Get statistics for a brand report

Authorizations

Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Path Parameters

reportId
string
required

Brand report identifier.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Query Parameters

startDate
string
required

Start date for the stats window (inclusive).

Minimum string length: 1
Example:

"2025-01-01"

endDate
string
required

End date for the stats window (inclusive).

Minimum string length: 1
Example:

"2025-01-31"

country
string
required

Country code to filter stats by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

Minimum string length: 1
Example:

"us"

engines

Optional. AI engine(s) to filter by. Repeat the param or pass a single value.

Available options:
chatgpt,
google,
perplexity,
copilot,
google_ai_mode,
gemini,
claude
Example:

"chatgpt"

tagId
string

Optional. Filter stats by tag id.

Response

Statistics for the brand report.

Brand report stats payload: meta, the tracked brand info, summary metrics, detected source brands, and per-analysis aggregates (all detected brands vs configured competitors).

id
string
required
status
string
required
isRecalculating
boolean
required
totalPrompts
integer
required
Required range: x >= 0
brand
object
required
summary
object
required
detectedBrands
object[]
required
allBrandsAnalysis
object
required
competitorBrandsAnalysis
object
required