API explorer
Getting Started

Sections

Theme switcher

Brand Visibility Over Time

Header Parameters

api-keystring

Query Parameters

granularitystring

Optional. Bucket size of the returned series: daily or weekly. When omitted, defaults to daily for date ranges under 90 inclusive days and weekly for ranges of 90 inclusive days or longer. Explicit weekly requires at least 14 inclusive days; otherwise HTTP 400. When weekly is requested with both dates omitted, the default window is 14 days.

Enum values:
dailyweekly
start_datestring

Optional. Absolute YYYY-MM-DD only (no relative or YYYY-MM values). May be provided independently of end_date. When both are omitted, defaults to the last 7 calendar days ending on the latest scrape day. When only start_date is provided, defaults to 7 calendar days starting on start_date. Must fall inside the campaign scraping window and span at most 90 inclusive days.

end_datestring

Optional. Absolute YYYY-MM-DD only (no relative or YYYY-MM values). May be provided independently of start_date. When both are omitted, defaults to the campaign's latest scrape day. When only end_date is provided, defaults to 7 calendar days ending on end_date. Must fall inside the campaign scraping window and span at most 90 inclusive days.

metricsarray

Comma-separated list of metrics: visibility, mention_share, total_mentions. Omitting this parameter returns all supported metrics.

Enum values:
visibilitymention_sharetotal_mentions
campaign_idstring Required

Unique campaign identifier (UUID format)

entity_typestring

Optional. Row grain: brand. Invalid values return HTTP 400.

Enum values:
brand
competitive_set_brandsboolean

Optional. When true, return only entity_role=competitor rows (exclude primary). Default is false.

brand_limitinteger

Optional. Number of top entities by visibility to return; primary brands and configured competitors outside that set are still included. Default is 30. Valid range is 1–100.

Minimum
1
Maximum
100
llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list)

Enum values:
chatgptgoogle_ai_modeperplexitygemini
formatstring

Format in which the reply should be returned

Enum values:
jsonxml
limitinteger

Page size. Default is 100. Valid range is 1–1000.

ascboolean | null

Sort direction: true for ascending, false for descending. Default is false (descending).

sortstring

Sort field applied to the full filtered result set before pagination. Supported values: date, entity_name, visibility, mention_share. Default is visibility (descending). Not sortable: entity_type, entity_role, parent, total_mentions.

offsetinteger

Defines the number of results to skip

Response

200
Object

OK

Response Attributes

metaobject
dataarray | null
400
Object

Bad Request

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?