Skip to main content
GET
List a brand's prompts with their metrics

Authorizations

X-API-KEY
string
header
required

Path Parameters

brand_id
string<uuid>
required

Query Parameters

page
integer
page_size
integer
sort
string

Comma-separated sort keys; prefix with - for descending. Valid keys: prompt, topic, region, visibility, sentiment, volume, competitors (by tracked-competitor count), last_run, citation_share. Unknown keys are ignored and the list falls back to visibility desc. (Note: the competitor sort key is competitors, NOT top_competitors — that is a response field, not a sort key.)

filter[query]
string

Prompt text ILIKE search

filter[topic_ids]
string[]
filter[provider_ids]
string[]
filter[region_ids]
string[]
filter[prompt_ids]
string<uuid>[]

Restrict the result set to these prompt_ids.

filter[brand_ids]
string[]

Found-brand restriction (legacy filter[brands]). Narrows visibility rows to these found_brand_ids.

filter[is_deleted]
boolean
filter[target_brand]
string
filter[citation_domain]
string
filter[citation_url]
string
filter[channel]
string
filter[subreddit]
string
filter[opportunity_id]
string<uuid>
filter[ran_at_start]
string<date-time>
filter[ran_at_end]
string<date-time>

Response

prompts returned

data
object[]
required
meta
object
required