Skip to main content
GET
List source pages

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard under Settings > API keys.

Query Parameters

relation
enum<string> | null

owned | contested | lost_ground | open

Available options:
lost_ground,
contested,
owned,
open
present
boolean | null

true: only pages the brand appears on. false: only pages it does not. Takes precedence over relation.

topic_id
integer | null
search
string | null
Maximum string length: 200
momentum
enum<string> | null

new | surging | steady | fading | dormant

Available options:
new,
surging,
steady,
fading,
dormant
actionable_only
boolean
default:false
active_only
boolean
default:false
limit
integer
default:50
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0
website_id
integer
required

Target website id

Response

Successful Response

pages
PublicSourcePage · object[]
required
total
integer
required
relation_counts
Relation Counts · object
plan_max
integer
default:0
total_in_store
integer
default:0