Skip to main content
GET
Get Source

Authorizations

Authorization
string
header
required

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

Path Parameters

brand_id
string<uuid>
required
domain
string
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
content_topic
string | null
Maximum string length: 300
actions_limit
integer
default:0
Required range: 0 <= x <= 100
actions_offset
integer
default:0
Required range: x >= 0
prompts_limit
integer
default:10
Required range: 1 <= x <= 100
prompts_offset
integer
default:0
Required range: x >= 0

Response

Successful Response

meta
Meta · object
required

Normalized query and newest included scan.

period
V1Period · object
required
source
V1SourceFacts · object
required