Skip to main content
GET
Get Page

Authorizations

Authorization
string
header
required

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

Path Parameters

brand_id
string<uuid>
required
page_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.

period
enum<string>
default:1w
Available options:
1w,
4w,
12w,
all
with_details
boolean
default:false
with_takes
boolean
default:false
takes_limit
integer
default:100
Required range: 1 <= x <= 100
takes_offset
integer
default:0
Required range: x >= 0

Response

Successful Response

ai_visits
integer | null
required
ai_visits_by_assistant
V1AssistantVisits · object[]
required
change
V1PageChange · object
required
changed_at
string<date-time> | null
required

When the crawl last saw its content change.

checks
V1PageCheck · object[]
required

Each check the latest content pass made of the page against rival pages.

citation_evidence
enum<string>
default:complete
required
Available options:
complete,
partial,
unavailable
citation_share_pct
number | null
required

This page's share of the citations the brand's own pages earn. Null where a weekly scan it covers could not keep all its citations.

citations
integer | null
required

Null where a weekly scan it covers could not keep all its citations.

cited_in
enum<string>
required
Available options:
tracked,
elsewhere,
search_only,
never
cited_on
V1PagePrompt · object[]
required
coverage
V1VisitCoverage · object | null
required
crawled_at
string<date-time> | null
required
crawler_bots
V1CrawlerBot · object[]
required
crawler_hits
integer | null
required
crawler_hits_days
integer
required
delivered_at
string<date-time> | null
required

When Heralded delivered the page, if it did.

delivery_cited_at
string<date-time> | null
required

The first weekly scan after the delivery that cited the page.

engines_citing
integer
required

The engines citing the page. A floor unless citation_evidence is complete.

engines_read
integer
required
first_cited_at
string<date-time> | null
required

The first kept citation's time. A floor unless citation_evidence is complete.

funnel
PageFunnel · object
required
funnel_series
PageFunnelPoint · object[]
required

The funnel on each weekly scan's 28-day window, oldest first, back as far as the plan's history reads. Empty without a weekly scan in that history.

id
string<uuid>
required
last_cited_at
string<date-time> | null
required

The last kept citation's time. A floor unless citation_evidence is complete.

meta
Meta · object
required

Normalized query and newest included scan.

page_type
string
required
page_type_decided_by
enum<string>
required
Available options:
model,
model_url,
rule
page_type_source
enum<string>
required
Available options:
member,
heralded
path
string
required
period
V1Period · object
required
piece
TopicPiece · object | null
required

The piece a Missing topic already has, in the words Studio uses.

piece_id is null while the order is still being placed: the brand's first order is dispatched before its writing profile exists, and the piece row is written once the worker has one.

prompts
integer | null
required

Null where a weekly scan it covers could not keep all its citations.

prompts_tracked
integer
required
read
boolean
required

Whether Heralded holds the page's text.

reason
string | null
required

Why the latest content pass wants the page improved.

rival_urls
string[]
required

The rival pages those checks compared it with.

rubric
V1PageRubricDetail · object | null
required
search
V1PageSearch · object | null
required
search_clicks
integer | null
required

Search Console clicks over the bound property's 28-day read; null without a read returning the page.

section
string
required
takes
PageTakeList · object | null
required

What AI took from the page, read from the evidence frozen with each scan and pinned by as_of. Present with with_takes. Open an item's answer at answers/{answer_read_id}.

title
string | null
required
topic
string | null
required

The tracked prompt the content pass matched it to.

topic_source
enum<string>
required
Available options:
member,
heralded
trend
V1PageTrendPoint · object[]
required

Citations in each weekly scan.

unavailable_scans
integer
default:0
required
unread_state
enum<string> | null
required
Available options:
blocked,
failed,
not_tried
url
string
required