Brand Visibility
Header Parameters
Query Parameters
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.
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.
Comma-separated list of metrics: visibility, mention_share, total_mentions, pop_change. Omitting this parameter returns all supported metrics.
visibilitymention_sharetotal_mentionspop_changeUnique campaign identifier (UUID format)
Optional. Row grain: brand. Invalid values return HTTP 400.
brandOptional. When true, return only entity_role=competitor rows (exclude primary). Default is false.
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.
Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list)
chatgptgoogle_ai_modeperplexitygeminiFormat in which the reply should be returned
jsonxmlPage size. Default is 100. Valid range is 1–1000.
Sort direction: true for ascending, false for descending. Default is false (descending).
Sort field applied to the full filtered result set before pagination. Supported values: entity_name, visibility, mention_share. Default is visibility (descending). date is not supported by this endpoint. Not sortable: entity_type, entity_role, parent, total_mentions, pop_change.
Defines the number of results to skip
Response
OK
Response Attributes
Show child attributes
Show child attributes
Bad Request