Skip to main content
GET
Get Pages

Authorizations

Authorization
string
header
required

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

Path Parameters

brand_id
string<uuid>
required

The brand's UUID from listBrands.

Query Parameters

market
string | null

Country ISO code, europe for pooled Europe, or global for no country. Omit for all.

audience

Audience UUID, or all_buyers for topics for all buyers. Omit for all.

engine
enum<string> | null

Answering AI engine.

Available options:
perplexity,
gemini,
openai,
google_aio,
ai_mode,
copilot,
claude
type
enum<string> | null

Question type.

Available options:
organic,
brand_specific,
competitor_comparison
intent
enum<string> | null

Question intent.

Available options:
educational,
problem,
comparison,
transactional
topic
string<uuid> | null

Tracked topic UUID.

prompt
string<uuid> | null

Question id from list_prompts.

limit
integer
default:20

Maximum rows (100).

Required range: 1 <= x <= 100
cursor
string | null

Prior next_cursor; keep filters and limit.

Maximum string length: 4096
as_of
string<uuid> | null

Completed scan id cutoff.

offset
integer
default:0

Rows to skip; prefer cursor paging.

Required range: x >= 0
period
enum<string>
default:1w

Weekly-report period.

Available options:
1w,
4w,
12w,
all
status
enum<string> | null

Filter by page status.

Available options:
covered,
weak,
missing,
unchecked,
cited,
falls_short,
ranks_in_search,
not_cited
q
string | null

Text to search for.

Maximum string length: 200
sort
enum<string>
default:demand

Field to order results by.

Available options:
topic,
status,
demand,
citations,
search_clicks,
ai_visits,
rank
direction
enum<string> | null

Order results ascending or descending.

Available options:
asc,
desc
with_menus
boolean
default:false

Include available filter choices.

url
string | null

The page URL to select.

Maximum string length: 4096

Response

Successful Response

coverage
V1VisitCoverage · object | null
required
crawler_hits_days
integer
required
limit
integer
required
meta
Meta · object
required

Normalized query and newest included scan.

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
V1OwnedPage · object[]
required
period
V1Period · object
required
resolved_page_id
string<uuid> | null
required
total
integer
required