Skip to main content
GET
Domain-level share overview (citation/mention series + type breakdown)

Authorizations

X-API-KEY
string
header
required

Path Parameters

brand_id
string<uuid>
required

Query Parameters

filter[target_brand]
string

Target brand name used for mention attribution. Defaults to the workspace brand's name.

filter[ran_at_start]
string<date-time>

Start of the ran_at window (ISO8601). Defaults to 30 days ago.

filter[ran_at_end]
string<date-time>

End of the ran_at window (ISO8601). Defaults to end of today.

filter[topic_ids]
string<uuid>[]
filter[brand_ids]
string<uuid>[]
filter[provider_ids]
string<uuid>[]
filter[region_ids]
string<uuid>[]
filter[granularity]
enum<string>

Period truncation for the time series (default day).

Available options:
day,
week,
month

Response

domains overview payload

data
object
required