Skip to main content
GET
List prompts 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 prompts window (inclusive).

Minimum string length: 1
Example:

"2025-01-01"

endDate
string
required

End date for the prompts window (inclusive).

Minimum string length: 1
Example:

"2025-01-31"

country
string
required

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

Minimum string length: 1
Example:

"us"

frequency
enum<string>

Optional. weekly buckets the periods by ISO week (a weekly run lands on its week's Monday; the current, unfinished week is left out). Defaults to weekly for a workspace monitored weekly, otherwise daily.

Available options:
daily,
weekly
Example:

"weekly"

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,
grok,
bing_ai_mode
Example:

"chatgpt"

tagId
string

Optional. Filter prompts by tag id.

Optional. Free-text search.

offset
integer

Optional. Zero-based offset for pagination; must be a multiple of limit, or of 25 when limit is omitted. Defaults to 0.

limit
integer

Optional. Maximum number of items to return. Defaults to 2000. The list holds at most 2000 prompts, the ones with the most brand mentions. When a report has more, only those 2000 can be fetched and totalCount is the full count (an upper bound: it can include prompts removed from the report), so stop paging on hasMore, not totalCount. With brandMentioned or competitors, totalCount counts matches among those 2000.

sortBy
string

Optional. Field to sort by: rank, prompt, volume, brandMentions or domainMentions. Other values are ignored and the default order is kept. With the default desc order, sortBy=rank puts the highest rank number first.

sortOrder
enum<string>

Optional. Sort direction. Defaults to desc. Only applies with sortBy.

Available options:
asc,
desc
brandMentioned
boolean

Optional. true keeps prompts with at least one brand mention; false keeps prompts with none.

competitors

Optional. Keeps prompts where any named competitor has at least one brand or domain mention. Names match exactly, ignoring case and surrounding spaces. Repeat the param for several names; a comma is part of the name.

domains

Optional. Returns only prompts whose AI answers cite one of the given domains between startDate and endDate. Each value is matched as an exact host, ignoring case and a leading www., so example.com does not match blog.example.com. Your brand domain or one of its variations matches all of the report's brand domains, and their subdomains when the report includes subdomains. Repeat the param for several domains. With domainCategories as well, a prompt must match both.

domainCategories

Optional. Returns only prompts whose AI answers cite a domain in one of the given categories between startDate and endDate. Competitor means the report's competitor domains, whatever their category. Unclassified means domains with no category yet. Repeat the param for several categories or pass a single value. With domains as well, a prompt must match both.

Available options:
Social Media,
Community/Forum,
Brand,
Encyclopedia,
News/Media,
Blogs/Personal Sites,
Government/NGO,
Education,
Video,
Competitor,
Others,
Unclassified
Example:

"News/Media"

Response

A page of prompts for the brand report.

items
object[]
required
paging
object
required
Example: