List Prompt Analytics Tool
list-prompt-analytics-toolPer-prompt aggregates (visibility, share-of-voice, sentiment, position) scoped to a single brand, plus the distinct tracked brands mentioned in each prompt's responses during the window. Paginated. To fetch more rows, request the next page; the envelope reports the total under meta.last_page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-indexed page number. Defaults to 1. | |
| tags | No | Tag IDs (prompt classifiers) to limit responses by. Optional. | |
| sort_by | No | Sort key. One of: visibility, share_of_voice, sentiment, position. Defaults to visibility. | |
| brand_id | Yes | Numeric ID of the brand to scope per-prompt metrics to. Must belong to the project. | |
| end_date | Yes | Inclusive UTC end of the analytics window. Must be on or after `start_date` and on or before today. | |
| interval | No | Bucket granularity for time-series tools. One of: day, week, month, year. Required for time-series tools, ignored for aggregate tools. | |
| monitors | No | Monitor IDs in the active project. Optional. | |
| per_page | No | Page size, 1-100. Defaults to 25. | |
| segments | No | Segment IDs (brand groupings) to slice analytics by. Optional. | |
| sort_dir | No | asc or desc. Defaults to desc. | |
| countries | No | ISO-3166-1 alpha-2 country codes to include. Optional. | |
| platforms | No | AI platforms to include. Optional. Values: chatgpt, perplexity, gemini, grok, copilot, claude, google_ai_mode, google_ai_overview. | |
| project_id | Yes | Project to compute analytics for. | |
| start_date | Yes | Inclusive UTC start of the analytics window. ISO 8601 date (YYYY-MM-DD). |