Skip to main content
GET
Get Scores

Authorizations

Authorization
string
header
required

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

Path Parameters

brand_id
string<uuid>
required

Query Parameters

as_of
string<uuid> | null

Include only scans up to this completed scan id.

limit
integer
default:10
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
cursor
string | null
Maximum string length: 4096
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
period
enum<string>
default:1w
Available options:
1w,
4w,
12w,
all
with_panes
boolean
default:false
figure_only
boolean
default:false
group_by
enum<string> | null

Also state the figures per engine, intent, prompt type, topic, segment, prompt or competitor, under the same period and filters.

Available options:
engine,
intent,
type,
topic,
segment,
prompt,
competitor
include
enum<string> | null

Also return the Engines table, or one engine's pane with the engine filter.

Available options:
engines,
engine
sort
enum<string>
default:score
Available options:
engine,
score,
trend,
mentioned,
recommended,
understood,
praised,
answers
direction
enum<string> | null
Available options:
asc,
desc
with_menus
boolean
default:false
with_cards
boolean
default:false
you
enum<string> | null
Available options:
named,
not_named
topic_id
string | null
Maximum string length: 100

Response

Successful Response

cards
HomeFigure · object[] | null
required
engine
V1EnginePane · object | null
required
engines
EnginesPage · object | null
required
groups
V1ScoreRow · object[] | null
required
heralded_score
V1Figure · object
required
mentioned
V1Figure · object
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.

next_cursor
string | null
required

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

pane_headline
V1PaneHeadline · object | null
required
pane_prompts
PerceptionPromptRow · object[]
required
pane_rivals
RivalAxes · object[]
required
panes
V1AxisPane · object[] | null
required
period
V1Period · object
required
praised
V1Figure · object
required
understood
V1Figure · object
required