Skip to main content
GET
Brand Mentions

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
search_term
string
Maximum string length: 255
brands
string<uuid>[]

Brand UUID filter. Pass a single brand UUID as brands[]=....

Maximum array length: 1
services
string[]

AI platform provider filters such as chatgpt or perplexity. Discover providers with GET /api/v1/platforms.

countries
string[]

Country code filters such as US or GB. Discover codes with GET /api/v1/countries.

tags
string[]

Tag UUID or name filters. Discover tags with GET /api/v1/projects/{project}/tags.

topics
string[]

Topic UUID or name filters. Use no_topic for prompts without a topic. Discover topics with GET /api/v1/projects/{project}/topics.

prompt
string<uuid>

Prompt UUID filter.

sentiments
string

Comma-separated list of sentiments. Allowed values: positive, negative, neutral.

rank_from
integer
Required range: x >= 1
rank_to
integer
Required range: x >= 1
per_page
integer
default:20
Required range: 1 <= x <= 100
sort_by
enum<string>
Available options:
rank
sort_direction
enum<string>
default:asc
Available options:
asc,
desc

Response

Paginated brand mentions.

data
object[]
required
meta
object
required