Skip to main content
GET
Get Perception Claim

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.

claim
string
required

A claim key from the claims list.

Required string length: 1 - 300

Query Parameters

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.

as_of
string<uuid> | null

Completed scan id cutoff.

period
enum<string>
default:1w

Weekly-report period.

Available options:
1w,
4w,
12w,
all
list_limit
integer | null

Maximum rows in each supporting list.

Required range: 1 <= x <= 100
prompts_offset
integer
default:0

Related prompts to skip.

Required range: x >= 0
sources_offset
integer
default:0

Sources to skip.

Required range: x >= 0
pages_offset
integer
default:0

Pages or opinion holders to skip.

Required range: x >= 0

Response

Successful Response

added_at
string<date-time> | null
required
brand_paused
boolean
default:false
required

Whether the brand's checks are paused.

claim
V1PerceptionClaimRow · object
required
definition
BrandFact · object | null
required

The current member-added fact and its original author. Null for a profile claim.

engines
V1PerceptionClaimEngine · object[]
required
filters
FigureFilters · object
required
meta
Meta · object
required

Normalized query and newest included scan.

next_fact_check_at
string<date-time> | null
required

The brand's next weekly report date, when scheduled.

pages
V1PerceptionContradictingPage · object[]
required
pages_total
integer
required

All pages under the selected filters before paging.

period
V1Period · object
required
prompts
V1PerceptionClaimPrompt · object[]
required
prompts_total
integer
required

All prompts matching this selection before paging.

quotes
V1PerceptionQuotedLine · object[]
required