Skip to main content
GET
Get 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"

Response

The brand report.

id
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

workspaceId
string
required
brand
string
required
brandDomain
string
required
countries
string[]
required

Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g. us, de), with uk used in place of gb.

createdDate
string
required
updatedDate
string
required
reportTitle
string
brandVariations
string[]
brandDomainVariations
string[]
brandDomainWildcard
boolean
promptIds
string[]
countryPromptsTotal
object

Total prompt count keyed by country code (lowercase ISO 3166-1 alpha-2; uk instead of gb).

competitors
object[]
tags
object[]