Skip to main content
GET
Get Competitor 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.

key
string
required

The competitor key or page hostname.

Required string length: 1 - 300

Query Parameters

country
string | null

Check country or global. Omit for all.

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
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.

period
enum<string>
default:1w

Weekly-report period.

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

The competitor page URL to read.

Maximum string length: 4096
section
enum<string> | null

Page this section with limit and offset; omit for both previews.

Available options:
questions,
work

Response

Successful Response

meta
Meta · object
required

Normalized query and newest included scan.

rival
RivalPagePane · object
required

The selected competitor page and its bounded citing questions and URL-specific work.