Get Brand Scorecard
get_scorecardAll entity scores across matching Scans: visibility, Share of Voice, signed sentiment, gap and composite health. Each data record is one Scan × entity; a Scan can span pages. Fixed pages of 20 records; history stays oldest first and excludes later completed Scans from continuation. No limit argument. Follow nextCursor with unchanged filters. Historical repairs and metadata edits require restarting. Metric dates are UTC calendar days; completedAt gives the exact Scan finish time. subjectContext is the saved Scan perspective, with null for unavailable legacy context. Percentages retain the complete evidence denominator.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Prompt tags from get_filter_options. | |
| brand | No | Returned entity identity IDs. Applied after percentage denominators are calculated. | |
| stage | No | Journey stage IDs or supported tokens from get_filter_options. | |
| cursor | No | nextCursor from this tool and subject. Keep filters unchanged; restart after metadata or evidence edits. | |
| region | No | Region codes from get_filter_options; unmeasured regions return empty evidence. | |
| siteId | Yes | Site or Topic ID from list_sites_and_topics. | |
| endDate | No | Inclusive UTC metric day, not Scan completion date. | |
| persona | No | Persona assignment IDs or supported tokens from get_filter_options. | |
| product | No | Product assignment IDs or supported tokens from get_filter_options. | |
| category | No | Prompt categories from get_filter_options. | |
| platform | No | ||
| promptId | No | Question IDs from list_prompts or get_prompt_results; includes retired prompt evidence. | |
| startDate | No | Inclusive UTC metric day, not Scan completion date. | |
| brandMention | No | Classifies prompt wording, not mentions in the collected answer. | |
| competitorId | No | Tracked competitor IDs from list_competitors; discovered competitors are refused. Combines with brand. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| total | Yes | ||
| filters | Yes | ||
| summary | Yes | ||
| nextCursor | Yes |