Skip to main content
GET
Get Sources

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.

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.

limit
integer
default:20

Maximum rows (100).

Required range: 1 <= x <= 100
cursor
string | null

Prior next_cursor; keep filters and limit.

Maximum string length: 4096
as_of
string<uuid> | null

Completed scan id cutoff.

offset
integer
default:0

Rows to skip; prefer cursor paging.

Required range: x >= 0
period
enum<string>
default:1w

Weekly-report period.

Available options:
1w,
4w,
12w,
all
owner
enum<string> | null

Filter by who owns the source.

Available options:
third_party,
competitor,
yours
source_type

Filter by source category.

Available options:
industry_authority,
review,
regulatory,
media,
educational,
community,
consulting,
social,
vendor,
directory,
unclassified
names_you
boolean | null

Keep sources that name the brand, or exclude them when false.

content_topic
string | null

Filter by the measured subject of a cited page.

Maximum string length: 300
domain
string | null

A source domain, including its subdomains, such as g2.com.

Maximum string length: 253
q
string | null

Text to search for.

Maximum string length: 200
direction
enum<string> | null

Order results ascending or descending.

Available options:
asc,
desc
with_menus
boolean
default:false

Include available filter choices.

with_trend
boolean
default:false

Include weekly card figures and their adjacent-window changes.

muted
boolean
default:false

List only muted sites when true.

opening
boolean | null

Filter sites by a pitchable opening that does not name you.

sells_placements
boolean | null

Keep sites known to sell placements, or exclude them when false.

with_summary
boolean
default:false

Include source summary counts.

sort
enum<string>
default:citations

Field to order results by.

Available options:
domain,
citations,
answers,
change,
priority,
recommends_you,
read_by_searchers
found_via
enum<string> | null

Filter by how the source was found.

Available options:
ai_citation,
google_ranking,
monitor

Response

Successful Response

card_figures
Card Figures · object
required

Weekly card figures and adjacent-window changes when with_trend=true.

channels
V1Channel · object[]
required
citation_evidence
enum<string>
default:complete
required
Available options:
complete,
partial,
unavailable
cited_sites
integer
default:0
required

Distinct cited sites under the filters.

limit
integer
required
meta
Meta · object
required

Normalized query and newest included scan.

mix
SourceMixSegment · object[]
required
muted_sites
integer
default:0
required

Muted sites under the filters before paging.

next_cursor
string | null
required

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

offset
integer
required
pages_total
integer | null
required

All pages under the selected filters before paging.

period
V1Period · object
required
read_sites
integer
default:0
required

Sites with a read cited page.

recommending
SourceRecommending · object
required
recommending_sites
integer
default:0
required

Sites with a cited page recommending you.

sites
integer
default:0
required

All listed sites before paging under the selected mute filter.

sites_total
integer | null
required

All source sites under the selected filters.

sources
V1Source · object[]
required
state
enum<string> | null
required
Available options:
ready,
awaiting_first_scan,
unavailable
total
integer
required
unavailable_scans
integer
default:0
required
worth_pursuing
SourceWorthRow · object[]
required
worth_pursuing_total
integer
default:0
required

All source opportunities under the selected filters before paging.