Skip to main content
GET
List Narratives

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.

sentiments
enum<string>[]

Sentiment filters. Repeat as sentiments[]=<sentiment>.

The sentiment valence of a mention or narrative.

Available options:
positive,
negative,
neutral
trajectory
enum<string>[]

Momentum filters: one or more bands (emerging, surging, steady, cooling, dormant) or named groups — rising (surging or emerging), fading (cooling or dormant), active (anything not fading). Repeat as trajectory[]=<band>; a single trajectory=<band> is also accepted.

Available options:
emerging,
surging,
steady,
cooling,
dormant,
rising,
fading,
active
sort
enum<string>

Sort order. Defaults to mentions. movement sorts by the change in response share versus the previous period.

Available options:
mentions,
recent,
sentiment,
first_seen,
movement
theme_ids
string<uuid>[]

Theme UUID filters. Repeat as theme_ids[]=<uuid>.

q
string

Free-text search over narrative labels and descriptions.

Maximum string length: 64
per_page
integer

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

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

Page number. Defaults to 1.

Required range: x >= 1

Response

Paginated narratives.

data
object[]
required
meta
object
required