Brand Visibility Report
get_brands_reportGenerate brand analytics reports with visibility, sentiment, share of voice, and mention metrics across AI models using date filters and dimensional breakdowns.
Instructions
Get brand analytics report per brand. Metrics: visibility (visibility_count/visibility_total), share_of_voice (0-1), mention_count, sentiment (0-100 scale, 50=neutral), position (avg rank when mentioned, lower=better). Returns up to limit results (default: 100). Use brand_id shortcut or filters array for server-side filtering. Supports date filtering and dimensional breakdowns. Without date filters, returns data across all available dates. Empty results may indicate the project has no report data for the given time range or filters — try a broader date range or fewer filters.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | No | Project ID (uses PEECAI_PROJECT_ID env if omitted). Call list_projects to find IDs. | |
| start_date | No | Start date (YYYY-MM-DD). Omit for no lower bound. | |
| end_date | No | End date (YYYY-MM-DD). Omit for no upper bound. | |
| dimensions | No | Breakdown dimensions. Each adds a grouping level to results: prompt_id (by search prompt), model_id (by AI model), model_channel_id (by model channel, e.g. openai-0/perplexity-0), tag_id (by category tag), topic_id (by topic group), date (by date), country_code (by country), chat_id (by individual chat). Multiple dimensions can be combined. | |
| brand_id | No | Convenience filter for a single brand (converted to server-side filter). Use list_brands to find IDs. | |
| filters | No | Server-side filters. Multiple filters are AND'd together. | |
| limit | No | Max results (1-10000, default: 100) | |
| offset | No | Results to skip |