Cookbook
Endpoints at a glance
Start from the question you're answering and jump straight to the endpoint and recipe that answers it
Paths are relative to https://api.getmint.ai/api, authenticated with X-API-Key. Start from the question on the left; the Key field is the one the matching recipe prints. Full schemas: API reference.
| Question you're answering | Endpoint | Key response field | Recipe |
|---|---|---|---|
| Which brands can this key see, and what's each id? | GET /domains | id, url, marketLanguageCodePairs | Find your domain id |
| What topics and competitors are configured? | GET /domains/{domainId}/topics | competitors[] | List topics & competitors |
| What's the headline Visibility Score for a topic? | GET /domains/{domainId}/topics/{topicId}/visibility/aggregated | averageScore, chartData[] | Visibility Score |
| Who wins share of voice in a topic? | GET /domains/{domainId}/topics/{topicId}/visibility/mentions | mentions[].percentage | Top mentions leaderboard |
| How do I compare against competitors? | GET /domains/{domainId}/topics/{topicId}/visibility/aggregated | chartData[].competitors, competitors[] | Compare competitors |
| What are a competitor's strengths and weaknesses? | GET /domains/{domainId}/topics/{topicId}/competition/aggregated | strengths[], weaknesses[] | Compare competitors |
| Which domains and URLs cite my brand? | GET /domains/{domainId}/explorer/citations | linkDomain, source | Citation rank by domain |
| Which sources need attention? | GET /domains/{domainId}/sources/visibility | mentionRate, needAttentionScore | Citation share for owned domains |
| How do I enrich a batch of source URLs? | POST /domains/{domainId}/sources/enrichment | enrichment rows | Enrich citations |
| What's the brand's sentiment? | GET /domains/{domainId}/sentiment/aggregated | overallScore | API reference |
| How aligned are answers with my brand attributes? | GET /domains/{domainId}/alignment/aggregated | averageScore | API reference |
| Which brands lead in shopping results? | GET /domains/{domainId}/shopping/analytics/top-brands | brands[] | API reference |
| How does a brand's shopping visibility trend? | GET /domains/{domainId}/shopping/analytics/brand-visibility | chartData.series[].data[] | API reference |
| What personas / segments can I filter by? | GET /tags | id, name | Segment Visibility |
visibility/aggregated powers several recipes: one call returns the headline score, the time series, and the per-competitor comparison, so each reads different fields of the same response.