Skip to main content
POST
Domains and pages the AI answers cite

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Project id (proj_…) or slug (the domain with dots as dashes).

Body

application/json
startDate
string<date>
endDate
string<date>
filters
object
groupBy
enum<string>
default:domain

domain or url rows, or one row per type: domainType (own, competitor, corporate, editorial, institutional, ugc, reference, other, unclassified) or pageType (homepage, category, product, listicle, comparison, profile, alternative, discussion, how_to, article, review, other, unclassified). Types are labelled automatically when a source is first seen; own and competitor come from the tracked brands’ domains

Available options:
domain,
url,
domainType,
pageType
domainTypes
enum<string>[]

Only sources whose domain has one of these types

Available options:
own,
competitor,
corporate,
editorial,
institutional,
ugc,
reference,
other,
unclassified
pageTypes
enum<string>[]

Only pages with one of these types

Available options:
homepage,
category,
product,
listicle,
comparison,
profile,
alternative,
discussion,
how_to,
article,
review,
other,
unclassified
role
enum<string>

sources (default): pages in the source list, retrieved or cited. links: pages linked in the answer text

Available options:
sources,
links
brandId
string
Maximum string length: 64
domains
string[]

Only pages of these domains (example.com). The answer totals keep counting every answer in scope

Maximum array length: 10
Maximum string length: 2048
urls
string[]

Only these pages

Maximum array length: 10
Maximum string length: 2048
dimension
enum<string>

Break each row down by date, week, assistant, topic or prompt. Needs domains or urls; every row is returned, without paging

Available options:
date,
week,
assistant,
topic,
prompt
compare
boolean

Add each row’s counts in the previous period of the same length (previous)

order
enum<string>

top (default): most answers first, paged with cursor. new: absent from the previous period. trending / losing: largest rise / fall of the share of answers against the previous period. Orders other than top return one page and include previous

Available options:
top,
new,
trending,
losing
limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string

nextCursor from the previous page, to read the next sources

Response

Report

period
object
required
previousPeriod
object | null
required
answerTotal
number
required
citableTotal
number
required

Answers from assistants that show inline citations (ChatGPT, Google AI Mode): the denominator of cited

previousAnswerTotal
number | null
required
previousCitableTotal
number | null
required
rowTotal
number
required
nextCursor
string | null
required
rows
object[]
required
{key}
any