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

The brand's UUID from listBrands.

domain
string
required

A source domain, such as g2.com.

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

Filter by the measured subject of a cited page.

Maximum string length: 300
actions_limit
integer
default:0

Maximum related actions to return; zero omits them.

Required range: 0 <= x <= 100
actions_offset
integer
default:0

Related actions to skip.

Required range: x >= 0
prompts_limit
integer
default:10

Maximum related prompts to return.

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

Related prompts to skip.

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