Skip to main content
GET
Get Cited Page

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.

as_of
string<uuid> | null

Completed scan id cutoff.

period
enum<string>
default:1w

Weekly-report period.

Available options:
1w,
4w,
12w,
all
key
string
required

The cited URL, canonical document key, or document id.

Required string length: 1 - 4096
prompts_limit
integer
default:10

Maximum related prompts to return.

Required range: 1 <= x <= 100
prompts_offset
integer
default:0

Related prompts to skip.

Required range: x >= 0

Response

Successful Response

answers
integer
required
citation_evidence
enum<string>
default:complete
required
Available options:
complete,
partial,
unavailable
citations
integer
required
content_type
string | null
required
description
string | null
required
document_id
string<uuid> | null
required
document_key
string
required
domain
string
required
engines
V1PageCitingEngine · object[]
required
introduced_at_run
integer | null
required
language
string
default:unknown
required
meta
Meta · object
required

Normalized query and newest included scan.

names
SourcePageName · object[] | null
required
names_you
boolean | null
required
owner
enum<string>
required
Available options:
third_party,
competitor,
yours
ownership
enum<string>
required
Available options:
own,
rival,
independent
period
V1Period · object
required
prompt_count
integer
required

Prompts represented by this row under the selected filters.

prompts
V1PageCitingPrompt · object[]
required
prompts_limit
integer
required
prompts_offset
integer
required
prompts_total
integer
required

All prompts matching this selection before paging.

reports
V1PageCitationReport · object[]
required
title
string | null
required
topic
V1SourceTopic · object | null
required
unavailable_scans
integer
default:0
required
url
string
required