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

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

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

Available options:
1w,
4w,
12w,
all
prompt_id
string<uuid> | null
names
string | null

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

Maximum string length: 200
you
enum<string> | null
Available options:
named,
recommended,
not_named
cites
string | null
Maximum string length: 4096
source_group
Available options:
own,
rival,
review,
editorial,
community,
vendor,
other
cited_page
string | null
Maximum string length: 4096
claim
string | null
Maximum string length: 1000
claim_wording
string | null
Maximum string length: 4096
content_topic
string | null
Maximum string length: 1000
action
string<uuid> | null
search
string | null
Maximum string length: 1000
sort
enum<string>
default:time
Available options:
time,
sources
direction
enum<string>
default:desc
Available options:
asc,
desc
with_menus
boolean
default:false

Response

Successful Response

answers
V1AnswerSummary · object[]
required
cited_page_key
string | null
required
cited_page_label
string | null
required
engine_vocabulary
EngineVocabulary · object[]
required
filter_options
AnswerFilterOptions · object
required

The brand's prompts and period-wide names and sources, before filtering.

has_more
boolean
default:false
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.

named_count
integer
default:0
required
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
source_group_label
string | null
required
summary_sentence
string
default:""
required
total
integer
required