Overview
Use the MentionLab REST API to manage projects, queries, and analytics from your own tools. This page covers the essentials you need before your first request.Base URL
All REST API requests use the following base URL:Requests and Responses
All requests and responses use JSON. Send and expect JSON payloads on every endpoint.Available Endpoints
The API is organized into the following groups. Mintlify auto-generates detailed documentation for each endpoint from the OpenAPI spec.| Group | Description |
|---|---|
| Projects | Create, update, list, and delete projects |
| Organisations | List your organisations |
| Queries | Manage queries, tags, locales, and counts |
| Entities | CRUD for entities, aliases, merge and unmerge |
| Tags | Create, update, delete, and link/unlink query tags |
| Execution Tags | Manage tags for job executions |
| Jobs | Trigger executions and track job status |
| Job Executions | Get AI models used by executions |
| Provider Restrictions | Check model availability by region |
| Analytics – Visibility | Visibility scores, share of voice, timeseries |
| Analytics – Tags | Per-tag stats, trends, and entity/source breakdowns |
| Analytics – Sources | Domain reach, top domains, URL-level drill-downs |
| Analytics – Shopping | Shopping overview, products, merchants, brands |
| Analytics – Sentiment | Sentiment overview, timeseries, per-entity breakdown |
| Analytics – Fan Outs | Follow-up question stats and per-query breakdowns |
| Analytics – Queries | Per-query stats, sources, entities, raw results |
| Analytics – Models | Per-model visibility, SoV, citations, position trends |
Next Steps
Authentication
Get your API key and set required headers.
Context Headers
Learn about organization and project headers.
Rate Limits
Understand API limits and retry behavior.