Skip to main content
GET
Get Topics

Authorizations

Authorization
string
header
required

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

Path Parameters

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

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
cursor
string | null
Maximum string length: 4096
period
enum<string>
default:1w
Available options:
1w,
4w,
12w,
all
status
enum<string> | null
Available options:
missing,
cited,
falls_short,
ranks_in_search,
not_cited
q
string | null
Maximum string length: 200
sort
enum<string>
default:demand
Available options:
topic,
status,
demand,
citations,
search_clicks,
ai_visits,
rank
direction
enum<string> | null
Available options:
asc,
desc
with_menus
boolean
default:false
url
string | null
Maximum string length: 4096

Response

Successful Response

Topics buyers ask about from the latest scan's content pass in the period.

ai_visits_connected
boolean
required
cards
V1TopicCards · object | null
required
cited
integer | null
required

Topics whose page is cited. Null where a weekly scan it covers could not keep all its citations.

covered
integer
required
limit
integer
required
menus
PromptFilters · object | null
required

What the toolbar's four menus offer, counted over every tracked prompt rather than over the page (PR-4). A menu built from one page of ten would hide the segment the eleventh row is in.

meta
Meta · object
required

Normalized query and newest included scan.

missing
integer | null
required

Null when the read saw too little of the site.

next_cursor
string | null
required

Pass as cursor with the same query to read the next page; null at the end.

not_read_line
string | null
required
offset
integer
required
period
V1Period · object
required
search_connected
boolean
required
sentence
string | null
required
state
enum<string>
required
Available options:
ready,
awaiting_first_scan,
not_measured
statuses
TopicStatusOption · object[]
required
topics
V1Topic · object[]
required
total
integer
required