Skip to main content
GET
Get Topic

Authorizations

Authorization
string
header
required

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

Path Parameters

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

Response

Successful Response

action
enum<string> | null
required
Available options:
write,
rewrite
action_label
string | null
required
ai_visits
integer | null
required
citation_evidence
enum<string>
default:complete
required
Available options:
complete,
partial,
unavailable
citations
integer | null
required

The page's citations in the period; null on a missing topic. Null where a weekly scan it covers could not keep all its citations.

demand
integer | null
required
id
string
required

The topic's key, which topics/{id} takes.

meta
Meta · object
required

Normalized query and newest included scan.

open_action_id
string<uuid> | null
required
page
V1TopicPage · object | null
required

The brand's page for it; null when missing.

page_checks
V1TopicPageChecks · object | null
required

Null on a missing topic.

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
V1TopicPrompt · object[]
required
prompts_total
integer
required
question_total
integer
required
questions
V1TopicQuestion · object[]
required
questions_answered
integer
required
search_clicks
integer | null
required
sources
V1TopicSource · object[]
required

The pages its prompts cite most.

status
enum<string>
required
Available options:
missing,
cited,
falls_short,
ranks_in_search,
not_cited
status_label
string
required
top_query
string | null
required

The page's top Search Console query.

topic
string
required
unavailable_scans
integer
default:0
required
why
string | null
required