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

The brand's UUID from listBrands.

Query Parameters

country
string | null

Check country or global. Omit for all.

q
string | null

Text to search for.

Maximum string length: 1000
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.

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
period
enum<string>
default:4w

Weekly-report period.

Available options:
1w,
4w,
12w,
all
prompt_type
string | null

Select a prompt type.

Maximum string length: 100
topic_id
string | null

Select a topic by id, or untagged for prompts without a topic.

Maximum string length: 100
sort
enum<string> | null

Field to order results by.

Available options:
volume,
change,
presence,
name,
prompt,
score,
trend
direction
enum<string> | null

Order results ascending or descending.

Available options:
asc,
desc
you
enum<string> | null

Keep prompts or answers matching this brand-presence state.

Available options:
named,
not_named
archived
boolean
default:false

Include archived prompts.

Response

Successful Response

active_total
integer
default:0
required

Active prompts using the brand prompt allowance, before list filters.

archived_total
integer
default:0
required

Archived prompts in the brand, before list filters.

engine_vocabulary
EngineVocabulary · object[]
required
filters
PromptFilters · object
required

Topic, type and intent choices counted over every tracked question.

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

Tracked prompts under market, audience, type, intent, topic and prompt filters, before text and brand-presence filters.