Cookbook
Visibility Score for one asset
Get a topic's headline Visibility Score and its change vs the previous period — in one call
GET
/domains/{domainId}/topics/{topicId}/visibility/aggregatedThe headline number on the topic Visibility tile plus its +3.2 pts badge — one call returns both, with the previous-period comparison computed server-side. This is the dashboard tile you're recreating (demo data):
Your Visibility Score
43%
1
2
3
4
Based on 120 answers
How this example works
- Omitting
startDatedefault: last 6 months — not all-time; pass explicit ISOstartDate/endDateto control the window. scoreVariationcompares the equal-length preceding window — a 30-day range vs the 30 days before it.averageScoreis a mention rate 0–100 across all prompts × models — how often the brand appeared, not a rank.
curl "https://api.getmint.ai/api/domains/$DOMAIN_ID/topics/$TOPIC_ID/visibility/aggregated?startDate=2026-06-21&endDate=2026-07-21" \
-H "X-API-Key: $MINT_API_KEY"Response (trimmed; full shape in API reference):
{
"averageScore": 42.5,
"scoreVariation": 3.2,
"brandShareOfVoice": 18.4,
"totalPromptsTested": 120,
"reportCount": 8,
"availableModels": ["gpt-5", "claude-sonnet-4", "gemini-2.5-flash", "gpt-interface"],
"dateRange": { "start": "2026-06-21", "end": "2026-07-21" }
}Query parameters
Prop
Type
Variations
| Change | Effect |
|---|---|
Drop startDate/endDate | Score over the default 6-month window |
models=gpt-5 | Headline scored on one model. modelBreakdown[] still lists every model (unfiltered rows carry no data), so read averageScore for the filtered figure. |
includeVariation=false | Skips the previous-period computation — scoreVariation comes back as 0 (the field stays present) |
Read brandShareOfVoice | Share of all brand mentions instead of answer-presence rate |