Skip to main content
GET
Get Perception

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.

period
enum<string>
default:1w
Available options:
1w,
4w,
12w,
all
list_limit
integer | null
Required range: 1 <= x <= 100
prompts_offset
integer
default:0
Required range: x >= 0
sources_offset
integer
default:0
Required range: x >= 0
pages_offset
integer
default:0
Required range: x >= 0

Response

Successful Response

best_quotes
V1PerceptionBestQuote · object[]
required
claims
V1PerceptionClaimRow · object[]
required
domain
string
required
filters
FigureFilters · object
required
menus
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.

meta
Meta · object
required

Normalized query and newest included scan.

negative_prompts
V1PerceptionNegativePrompt · object[]
required
negative_prompts_total
integer
required
negative_sources
V1PerceptionNegativeSource · object[]
required
negative_sources_total
integer
required
period
V1Period · object
required
praised
V1Figure · object
required
understood
V1Figure · object
required
written
V1PerceptionWrittenPieces · object
required

What the latest weekly report's interpretation wrote, over every answer and every engine: none of it follows the period or a filter.