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

promptId
string
required

Prompt identifier within the brand report.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

Query Parameters

startDate
string
required

Start date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 00:00:00.000Z.

Minimum string length: 1
Example:

"2025-01-01"

endDate
string
required

End date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 23:59:59.999Z.

Minimum string length: 1
Example:

"2025-01-31"

country
string
required

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

Minimum string length: 1
Example:

"us"

Response

Details for the prompt within the brand report.

id
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

reportId
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

prompt
string
required
intentVolume
number
required
brandCoverageHistory
object[]
required
brandRank
object[]
required
domainCategories
object[]
required
brandReports
object[]
required
tags
object[]
required