Skip to main content
GET
Get Answers

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

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> | null

Weekly-report period; omitted for all weekly and daily answers.

Available options:
1w,
4w,
12w,
all
read_since
string<date-time> | null

Keep answers whose run completed at or after this ISO 8601 time. With period=all it reads every weekly and daily answer once, as without period.

names
string | null

Only answers that name this brand, such as a rival's name.

Maximum string length: 200
you
enum<string> | null

Keep prompts or answers matching this brand-presence state.

Available options:
named,
recommended,
not_named
cites
string | null

Keep answers citing this URL or domain.

Maximum string length: 4096
source_group

Keep answers citing this source group.

Available options:
own,
rival,
review,
editorial,
community,
vendor,
other
cited_page
string | null

Keep answers citing this page.

Maximum string length: 4096
claim
string | null

A claim key from the claims list.

Maximum string length: 1000
claim_wording
string | null

The exact wording of the selected claim.

Maximum string length: 4096
content_topic
string | null

Filter by the measured subject of a cited page.

Maximum string length: 1000
action
string<uuid> | null

An action id whose supporting answers to read.

sort
enum<string>
default:time

Field to order results by.

Available options:
time,
sources
direction
enum<string>
default:desc

Order results ascending or descending.

Available options:
asc,
desc
with_menus
boolean
default:false

Include available filter choices.

prompt_id
string<uuid> | null

Question id from list_prompts.

Response

Successful Response

answers
V1AnswerSummary · object[]
required
cited_page_key
string | null
required
engine_vocabulary
EngineVocabulary · object[]
required
has_more
boolean
default:false
required
limit
integer
required
meta
Meta · object
required

Normalized query and newest included scan.

named_count
integer
default:0
required

Answers in the selection that name the brand.

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

Answers in the selection that recommend the brand.

total
integer
required