Skip to main content
GET
Get Prompts

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:4w
Available options:
1w,
4w,
12w,
all
prompt_type
string | null
Maximum string length: 100
topic_id
string | null
Maximum string length: 100
sort
enum<string> | null
Available options:
volume,
change,
presence,
name,
prompt,
score,
trend
direction
enum<string> | null
Available options:
asc,
desc
you
enum<string> | null
Available options:
named,
not_named
search
string | null
Maximum string length: 1000
archived
boolean
default:false

Response

Successful Response

active_total
integer
default:0
required
archived_total
integer
default:0
required
engine_vocabulary
EngineVocabulary · object[]
required
filters
PromptFilters · object
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.

has_more
boolean
default:false
required
limit
integer
required
measurement
KeywordMeasurement · object | null
required
meta
Meta · object
required

Normalized query and newest included scan.

next_cursor
string | null
required

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

offset
integer
required
period
V1Period · object | null
required
prompt_text_max_len
integer
default:200
required
prompts
V1Prompt · object[]
required
sort
enum<string>
default:volume
required
Available options:
volume,
change,
presence,
name,
prompt,
score,
trend
total
integer
required
tracked_total
integer
default:0
required