Skip to main content
GET
Most-cited pages

Authorizations

X-API-KEY
string
header
required

Path Parameters

brand_id
string<uuid>
required

Query Parameters

page
integer

Page number (default 1).

page_size
integer

Items per page (default 25, max 100).

sort
string

Comma-separated sort keys, - prefix for descending. Keys: total_citation_count, citation_count, total_citation_percent, brand_citation_count, brand_citation_percent, page, domain, page_type. Default: -citation_count, domain, page.

filter[query]
string

Free-text (ILIKE) match against the page URL or its domain.

filter[domains]
string[]

Restrict to citations on these exact citation domains.

filter[page_types]
enum<string>[]

Match any of these page_type values (article, documentation, homepage, ...).

Available options:
homepage,
article,
discussion,
social,
product_page,
review,
comparison,
alternative,
listicle,
how_to_guide,
category_page,
documentation,
pricing,
about,
case_study,
features,
resource,
contact,
careers,
other
filter[citation_types]
enum<string>[]

Static domain types (editorial, review, saas, ...) and/or dynamic ownership types (owned, earned, competitor_owned, competitor_earned).

Available options:
editorial,
review,
institutional,
social,
commerce,
documentation,
reference,
saas,
legal,
health,
finance,
research,
app_store,
directory,
corporate,
search_engine,
other,
owned,
earned,
competitor_owned,
competitor_earned
filter[channel]
string

Restrict to citations from this YouTube channel (matched by video author).

filter[subreddit]
string

Restrict to citations from this subreddit.

filter[prompt_id]
string<uuid>

Restrict to citations from a single prompt (AND-combines with filter[topic_ids]).

filter[prompt_regions]
string[]

Restrict to specific (prompt, region) pairs — each item "promptId,regionId". Replaces the legacy per-prompt/region cited-pages export.

filter[ran_at_start]
string<date-time>

Start of the ran_at window (ISO8601 date or datetime). Defaults to 30 days ago.

filter[ran_at_end]
string<date-time>

End of the ran_at window (ISO8601 date or datetime). Defaults to end of today.

filter[target_brand]
string

Brand name whose citations count toward brand_citation_count / target_brand_mentioned. Defaults to the workspace brand's name (downcased).

filter[topic_ids]
string<uuid>[]

Restrict to citations from prompts belonging to these topics (topic ids are resolved to prompt ids).

filter[brand_ids]
string<uuid>[]

Restrict to citations attributed to these brand-mapping ids (found_brand_id). When omitted, all citations for the brand are returned and target counts are computed from filter[target_brand].

filter[provider_ids]
string<uuid>[]

Restrict to citations from prompt runs on these providers.

filter[region_ids]
string<uuid>[]

Restrict to citations from prompt runs in these regions.

Response

cited pages

data
object[]
required
meta
object
required