Skip to main content
GET
Get Cited Pages

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

Query Parameters

engine
enum<string> | null
Available options:
perplexity,
gemini,
openai,
google_aio,
ai_mode,
copilot,
claude
prompt
string<uuid> | null
type
enum<string> | null
Available options:
organic,
brand_specific,
competitor_comparison
intent
enum<string> | null
Available options:
educational,
problem,
comparison,
transactional
topic
string<uuid> | null
segment
string | null
as_of
string<uuid> | null

Include only scans up to this completed scan id.

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
cursor
string | null
Maximum string length: 4096
period
enum<string>
default:1w
Available options:
1w,
4w,
12w,
all
owner
enum<string> | null
Available options:
third_party,
competitor,
yours
source_type
Available options:
industry_authority,
review,
regulatory,
media,
educational,
community,
consulting,
social,
vendor,
directory,
unclassified
names_you
boolean | null
content_topic
string | null
Maximum string length: 300
q
string | null
Maximum string length: 200
direction
enum<string> | null
Available options:
asc,
desc
with_menus
boolean
default:false
domain
string | null
Maximum string length: 253
sort
enum<string>
default:citations
Available options:
title,
citations,
prompts

Response

Successful Response

cards
SourcesCards · object | null
required
citation_evidence
enum<string>
default:complete
required
Available options:
complete,
partial,
unavailable
limit
integer
required
menus
SourcesMenus · object | null
required

The page's filter menus: the prompt set's four, every source type and every tracked prompt. None follows the filters, so choosing one hides no other.

meta
Meta · object
required

Normalized query and newest included scan.

mix
SourceMixSegment · object[]
required
next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

offset
integer
required
pages
V1SourcePage · object[]
required
pages_total
integer | null
required
period
V1Period · object
required
sentence
string | null
required
sites_total
integer | null
required
state
enum<string> | null
required
Available options:
ready,
awaiting_first_scan,
unavailable
total
integer
required
unavailable_scans
integer
default:0
required