Skip to main content
GET
List a brand's topics with their metrics and prompt counts

Authorizations

X-API-KEY
string
header
required

Path Parameters

brand_id
string<uuid>
required

Query Parameters

filter[target_brand]
string

Brand name whose mentions count as 'target' metrics (default: the brand's own name)

filter[brand_ids]
string<uuid>[]

Found-brand mapping ids — scopes which found-brand rows count toward visibility/SOV/sentiment and top_brands (denominators stay unscoped)

filter[provider_ids]
string<uuid>[]

Provider ids to scope metrics to

filter[region_ids]
string<uuid>[]

Region ids to scope metrics to

filter[topic_ids]
string<uuid>[]

Topic ids to scope the list to (default: all of the brand's topics)

filter[ran_at_start]
string<date-time>

Period start (default 30 days ago); previous period is derived for diffs

filter[ran_at_end]
string<date-time>

Period end (default now)

filter[get_empty]
boolean

true also returns topics with no active prompts (zeroed metrics, prompt_count 0); default false

Response

topics returned

data
object[]
required