Skip to main content
GET
Reputation Sources (URLs)

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

project
string<uuid>
required

Project UUID.

Query Parameters

start_date
string<date>
required
end_date
string<date>
required

Must be on or after start_date.

tags
string[]

Tag UUID or name filters. Repeat as tags[]=<uuid-or-name>. Discover tags with GET /api/v1/projects/{project}/tags.

services
string[]

AI platform provider filters such as chatgpt or perplexity. Repeat as services[]=<provider>. Discover providers with GET /api/v1/platforms.

countries
string[]

Country code filters such as US or GB. Repeat as countries[]=<code>. Discover codes with GET /api/v1/countries.

topics
string[]

Topic UUID or name filters. Use no_topic for prompts without a topic. Repeat as topics[]=<uuid-or-name>. Discover topics with GET /api/v1/projects/{project}/topics.

prompt
string<uuid>

Prompt UUID filter.

brand
string<uuid>

Brand UUID to scope the reputation data to. Must belong to the project. Defaults to the project's primary brand; when the project has no primary brand an explicit brand is required. Discover brand UUIDs with GET /api/v1/projects/{project}/brands.

scope_type
enum<string>
required

The entity the source rollup is scoped to: a narrative, a theme, or a brand (every response that mentions the brand).

Available options:
narrative,
theme,
brand
scope_uuid
string<uuid>
required

The UUID of the narrative, theme, or brand named by scope_type.

categories
enum<string>[]

Domain category filters. Repeat as categories[]=<category>. Discover values with GET /api/v1/domain-categories.

Available options:
ugc,
editorial,
corporate,
reference,
academic,
analyst,
institutional,
other
domain
string

Scope results to URLs under this domain. Ignored when hostname is also provided.

hostname
string

Scope results to URLs under this hostname. Takes precedence over domain.

search_term
string

Free-text filter over the listed sources.

Maximum string length: 255
per_page
integer

Results per page, 1-100. Defaults to 20.

Required range: 1 <= x <= 100
page
integer

Page number. Defaults to 1.

Required range: x >= 1

Response

Paginated URL sources.

data
object[]
required
meta
object
required