# MentionLab

- [Introduction](https://docs.mentionlab.io/index.md): Monitor and analyze your brand's presence across AI platforms
- [Core Concepts](https://docs.mentionlab.io/guides/core-concepts.md): Understand the key building blocks of MentionLab
- [Quickstart](https://docs.mentionlab.io/guides/quickstart.md): Create your first project and run your first AI brand analysis
- [Dashboard Overview](https://docs.mentionlab.io/guides/dashboard.md): Understand every card on your project dashboard
- [Queries & Tags](https://docs.mentionlab.io/guides/queries-and-tags.md): Create, import, and organize the questions you send to AI platforms
- [Competitors & Brands](https://docs.mentionlab.io/guides/competitors-and-brands.md): Configure the brands and competitors you want to track across AI platforms
- [Filters & Sharing](https://docs.mentionlab.io/guides/filters-and-comparisons.md): Slice your data by date range, tags, AI models and more — then share the exact view
- [Platform Comparison](https://docs.mentionlab.io/guides/platform-comparison.md): Compare your brand's performance across different AI platforms
- [Sources](https://docs.mentionlab.io/guides/sources.md): See which websites AI platforms cite, and how much of that content mentions your brand
- [Sentiment Analysis](https://docs.mentionlab.io/guides/sentiment-analysis.md): Understand how AI models talk about your brand — positively, neutrally, or negatively
- [Shopping](https://docs.mentionlab.io/guides/shopping.md): Track how your brands, products and retailers appear in AI shopping results
- [Fan-outs](https://docs.mentionlab.io/guides/fan-outs.md): See the follow-up questions AI platforms suggest after answering your queries
- [Social — YouTube](https://docs.mentionlab.io/guides/social-youtube.md): See which YouTube channels and videos AI models cite when answering your queries
- [Organization & Billing](https://docs.mentionlab.io/guides/organization-and-billing.md): Manage your team, roles, tokens, and API keys
- [Project Settings](https://docs.mentionlab.io/guides/project-settings.md): Configure models, schedules, entities, tags and members
- [Metrics Glossary](https://docs.mentionlab.io/guides/metrics-glossary.md): What every MentionLab metric actually measures, and how it is computed
- [Models Availability](https://docs.mentionlab.io/guides/models-availability.md): Check which AI models can run in which countries
- [Getting Started](https://docs.mentionlab.io/rest-api/getting-started.md): Learn the basics of the MentionLab REST API
- [Authentication](https://docs.mentionlab.io/rest-api/authentication.md): Authenticate with an API key and project context
- [Context Headers](https://docs.mentionlab.io/rest-api/headers.md): Understanding x-organisation-id and x-project-id headers
- [MCP Server](https://docs.mentionlab.io/rest-api/mcp-server.md): Connect MentionLab to AI tools using the Model Context Protocol
- [Get a project](https://docs.mentionlab.io/api-reference/projects/get-a-project.md): Returns a single project by its identifier; the path id must match the project header or the request is rejected.
- [Delete a project](https://docs.mentionlab.io/api-reference/projects/delete-a-project.md): Deletes the project identified by the path id; the path id must match the project header or the request is rejected.
- [List projects of the organisation](https://docs.mentionlab.io/api-reference/projects/list-projects-of-the-organisation.md): Returns a paginated list of projects the user or organisation can access, optionally filtered by name.
- [Update a project](https://docs.mentionlab.io/api-reference/projects/update-a-project.md): Updates a project's editable fields; the path `id` must match the `x-project-id` header.
- [Update project settings](https://docs.mentionlab.io/api-reference/projects/update-project-settings.md): Replaces the project's free-form settings blob (e.g. saved custom filters) with the supplied object. The FE owns the full object, so add/edit/remove are all this one call. Path `id` must match the `x-project-id` header.
- [Countries and languages of a project’s locales](https://docs.mentionlab.io/api-reference/projects/countries-and-languages-of-a-project’s-locales.md): Distinct countries/languages for the project. `source=runs` (default) = locales from real executions; `source=config` = the configured queries allowlist (may include never-run locales).
- [Last job execution date for a project](https://docs.mentionlab.io/api-reference/projects/last-job-execution-date-for-a-project.md): Returns the date of the project's most recent job execution as a data-freshness indicator, or `null` if it has never run a job.
- [Distinct AI models used in a project](https://docs.mentionlab.io/api-reference/projects/distinct-ai-models-used-in-a-project.md): Returns the distinct AI models that have been run for the project, including models whose runs are still pending or failed; the path `id` must match the `x-project-id` header.
- [Create queries](https://docs.mentionlab.io/api-reference/queries/create-queries.md): Creates (upserts) several queries at once along with their tag associations; all referenced tag IDs are validated against the project first.
- [Bulk-update tag associations for queries matched by text/language/country](https://docs.mentionlab.io/api-reference/queries/bulk-update-tag-associations-for-queries-matched-by-textlanguagecountry.md): Replaces the tag associations of existing queries matched by their text, language and country rather than by id; only the tags are changed.
- [Get all queries](https://docs.mentionlab.io/api-reference/queries/get-all-queries.md): Returns a paginated list of the project's queries, applying the filters and sorting from the request body; each result includes its tag IDs.
- [Get total query count for a project](https://docs.mentionlab.io/api-reference/queries/get-total-query-count-for-a-project.md): Returns the total number of queries in the project.
- [Get a query by ID](https://docs.mentionlab.io/api-reference/queries/get-a-query-by-id.md): Returns a single query with its tags by UUID; a query belonging to another project is treated as not found.
- [Delete a query](https://docs.mentionlab.io/api-reference/queries/delete-a-query.md): Deletes the query. Previously generated results and responses are kept but unlinked from the query.
- [Update a query's type or tag associations](https://docs.mentionlab.io/api-reference/queries/update-a-querys-type-or-tag-associations.md): Updates a query by UUID to change its type and/or replace its tag associations; the supplied tag IDs are validated against the project.
- [Create a new entity](https://docs.mentionlab.io/api-reference/entities/create-a-new-entity.md): Creates a new entity (brand, person, company, or other) in the project, automatically generating a default alias from its name.
- [Get entity by ID](https://docs.mentionlab.io/api-reference/entities/get-entity-by-id.md): Returns the full detail for a single entity, including its group, its aliases, and any entities merged into it.
- [Delete an entity](https://docs.mentionlab.io/api-reference/entities/delete-an-entity.md): Permanently deletes an entity and its aliases; fails if it is still referenced, so blacklist it instead to hide it while keeping historical data.
- [Update an entity](https://docs.mentionlab.io/api-reference/entities/update-an-entity.md): Partially updates an entity's name, type, classification flags and group; setting the group to null removes it from its group. Renaming also regenerates the slug and adds the new name as an alias, keeping the old one so past mentions still resolve.
- [List entities with filters](https://docs.mentionlab.io/api-reference/entities/list-entities-with-filters.md): Returns a paginated list of entities, excluding merged entities by default, with filtering and sorting options.
- [Bulk update classification flags on multiple entities](https://docs.mentionlab.io/api-reference/entities/bulk-update-classification-flags-on-multiple-entities.md): Updates classification flags on several entities at once; only the flags provided are changed, and the call is rejected when none are supplied.
- [Recompute the project-scoped source-domain relationships](https://docs.mentionlab.io/api-reference/entities/recompute-the-project-scoped-source-domain-relationships.md): Recomputes each cited source domain's relationship (owned / competitor / partner_affiliate; absence ⇒ independent) for the project from the current entity-domain mappings; a manual trigger to run after editing owned/competitor/partner entities or their domains.
- [Import entities from a spreadsheet (create and update)](https://docs.mentionlab.io/api-reference/entities/import-entities-from-a-spreadsheet-create-and-update.md): Creates or updates a batch of rows in one transaction, matching each by `id` or by name; omitted fields are left unchanged and aliases are only ever added. Use dryRun to preview the per-row outcome, and POST /entities/import/merge afterwards for the mergedIntoId column.
- [Merge entities in bulk from a spreadsheet](https://docs.mentionlab.io/api-reference/entities/merge-entities-in-bulk-from-a-spreadsheet.md): Applies the `mergedIntoId` column of an entity import, merging each entity into the one its id names. Send the whole file in one request: chains and cycles are resolved across the entire edge set, so a partial batch resolves differently. Bad edges fail their own row and leave the rest to apply.
- [Add an alias to an entity](https://docs.mentionlab.io/api-reference/entities/add-an-alias-to-an-entity.md): Adds a new alias to the entity; aliases are unique per project, so adding one that already exists returns 409 Conflict.
- [Remove an alias from an entity](https://docs.mentionlab.io/api-reference/entities/remove-an-alias-from-an-entity.md): Removes an alias from the entity; an entity must keep at least one alias, so removing the last remaining one returns 400.
- [Merge entities into a target](https://docs.mentionlab.io/api-reference/entities/merge-entities-into-a-target.md): Merges the source entities into the target so they report under it in analytics; the merge can be reversed via the unmerge endpoint, though conflicting alias variants dropped during the merge are not restored.
- [Unmerge entities in bulk](https://docs.mentionlab.io/api-reference/entities/unmerge-entities-in-bulk.md): Makes previously merged entities independent again, named either directly with `ids` or by survivor with `survivorIds` to release everything merged into them. Ids that are not currently merged are skipped, so the same list can be re-sent safely.
- [Unmerge a previously merged entity](https://docs.mentionlab.io/api-reference/entities/unmerge-a-previously-merged-entity.md): Reverses a merge, making the entity independent again; only works on entities that were previously merged.
- [Get organisations for the current user](https://docs.mentionlab.io/api-reference/organisations/get-organisations-for-the-current-user.md): Lists every organisation the current user can access, directly as a member or indirectly through membership of one of its projects.
- [Trigger an execution for all project queries](https://docs.mentionlab.io/api-reference/jobs/trigger-an-execution-for-all-project-queries.md): Runs every query in the project against the selected AI models for the requested number of executions, charging the required credits up front; returns null when the project has no queries.
- [Get a job by ID](https://docs.mentionlab.io/api-reference/jobs/get-a-job-by-id.md): Retrieves a single job by its ID within the project.
- [List jobs](https://docs.mentionlab.io/api-reference/jobs/list-jobs.md): Returns a paginated list of jobs for the project, applying the filtering and sorting from the request body and including each job creating user.
- [Create multiple tags](https://docs.mentionlab.io/api-reference/tags/create-multiple-tags.md): Creates several tags at once and returns the newly created tags.
- [List tags](https://docs.mentionlab.io/api-reference/tags/list-tags.md): Returns a paginated list of tags matching the supplied filters, optionally with the linked-query count per tag.
- [Get a tag](https://docs.mentionlab.io/api-reference/tags/get-a-tag.md): Returns a single tag by its id.
- [Delete a tag](https://docs.mentionlab.io/api-reference/tags/delete-a-tag.md): Permanently deletes the tag.
- [Update a tag](https://docs.mentionlab.io/api-reference/tags/update-a-tag.md): Updates the name, color and/or group of a tag. Send groupId null to ungroup.
- [Move a selection of tags to a group](https://docs.mentionlab.io/api-reference/tags/move-a-selection-of-tags-to-a-group.md): Files every tag in the selection (either explicit ids, or all tags matching a filter except the excluded ids) under the given tag group node, or ungroups them when groupId is null. Never triggers tag re-matching.
- [Link tags to queries](https://docs.mentionlab.io/api-reference/tags/link-tags-to-queries.md): Associates every supplied tag with every supplied query, skipping links that already exist.
- [Unlink tags from queries](https://docs.mentionlab.io/api-reference/tags/unlink-tags-from-queries.md): Removes the association between every supplied tag and every supplied query.
- [List tag groups](https://docs.mentionlab.io/api-reference/tag-groups/list-tag-groups.md): Returns the list of tag groups of one taxonomy.
- [Create a tag group](https://docs.mentionlab.io/api-reference/tag-groups/create-a-tag-group.md): Creates a folder for tags of one taxonomy.
- [Delete a tag group](https://docs.mentionlab.io/api-reference/tag-groups/delete-a-tag-group.md): Deletes a tag group; returns no content on success. Member tags are never deleted — they become ungrouped.
- [Update a tag group](https://docs.mentionlab.io/api-reference/tag-groups/update-a-tag-group.md): Renames or recolors a tag group; returns no content on success. The taxonomy is immutable.
- [Create multiple execution tags](https://docs.mentionlab.io/api-reference/execution-tags/create-multiple-execution-tags.md): Creates multiple execution tags from the supplied array.
- [Move a selection of execution tags to a group](https://docs.mentionlab.io/api-reference/execution-tags/move-a-selection-of-execution-tags-to-a-group.md): Files every execution tag in the selection (either explicit ids, or all execution tags matching a filter except the excluded ids) under the given tag group node, or ungroups them when groupId is null. Never triggers tag re-matching or re-embedding.
- [List all execution tags](https://docs.mentionlab.io/api-reference/execution-tags/list-all-execution-tags.md): Returns a paginated list of the project's execution tags matching the filters in the request body.
- [Get an execution tag](https://docs.mentionlab.io/api-reference/execution-tags/get-an-execution-tag.md): Retrieves a single execution tag by its id.
- [Delete an execution tag](https://docs.mentionlab.io/api-reference/execution-tags/delete-an-execution-tag.md): Deletes an execution tag; rejected if no matching tag exists in the project.
- [Update an execution tag](https://docs.mentionlab.io/api-reference/execution-tags/update-an-execution-tag.md): Updates the name, color and/or matching mode of an execution tag; rejected if no matching tag exists in the project. Renaming a tag or changing its matching mode recomputes all of the tag's execution links, manual links included.
- [Link execution tags to job executions](https://docs.mentionlab.io/api-reference/execution-tags/link-execution-tags-to-job-executions.md): Links the given execution tags to the given job executions; existing links are ignored, and the call fails if any tag or job execution is not in the project. Renaming a tag or changing its matching mode recomputes all of the tag's execution links, manual links included.
- [Unlink execution tags from job executions](https://docs.mentionlab.io/api-reference/execution-tags/unlink-execution-tags-from-job-executions.md): Removes the links between the given execution tags and job executions; fails if any tag or job execution is not in the project. Renaming a tag or changing its matching mode recomputes all of the tag's execution links, manual changes included.
- [List custom metrics the current organisation has access to](https://docs.mentionlab.io/api-reference/analytics--custom-metrics/list-custom-metrics-the-current-organisation-has-access-to.md): Lists the custom metrics granted by the organisation's plan, ordered for dashboard display.
- [Run a table-shaped custom metric](https://docs.mentionlab.io/api-reference/analytics--custom-metrics/run-a-table-shaped-custom-metric.md): Runs the requested table-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.
- [Run a timeseries-shaped custom metric](https://docs.mentionlab.io/api-reference/analytics--custom-metrics/run-a-timeseries-shaped-custom-metric.md): Runs the requested timeseries-shaped custom metric for the project and returns its results; the supplied filter is validated and the metric must be granted by your plan.
- [Theme-analysis pipeline status for the project](https://docs.mentionlab.io/api-reference/theme-analysis/theme-analysis-pipeline-status-for-the-project.md): Read-only progress snapshot: whether an analysis is running (extraction/clustering in flight), pending (completed prompt runs queued for the next poll), or idle (up to date), plus the underlying counts.
- [Run theme analysis on the project's pending completed jobs](https://docs.mentionlab.io/api-reference/theme-analysis/run-theme-analysis-on-the-projects-pending-completed-jobs.md): Immediately enqueues the project terminal jobs not yet handed off for theme analysis (the same set the poller would pick up within ~1 min). Requires the project toggle to be on. Pass force=true to also re-run already-processed jobs.
- [Create a new entity group](https://docs.mentionlab.io/api-reference/entity-groups/create-a-new-entity-group.md): Creates a new entity container and returns it. By default a top-level group; pass kind "division" (optionally with a parentId) to create a division.
- [Get entity group by ID](https://docs.mentionlab.io/api-reference/entity-groups/get-entity-group-by-id.md): Returns a single entity group by its ID.
- [Delete an entity group](https://docs.mentionlab.io/api-reference/entity-groups/delete-an-entity-group.md): Permanently deletes an entity group; returns no content on success.
- [Update an entity group](https://docs.mentionlab.io/api-reference/entity-groups/update-an-entity-group.md): Applies a partial update to an entity group; returns no content on success.
- [List entity groups](https://docs.mentionlab.io/api-reference/entity-groups/list-entity-groups.md): Returns a paginated list of entity groups matching the supplied filters.
- [Add entities to a group](https://docs.mentionlab.io/api-reference/entity-groups/add-entities-to-a-group.md): Adds the given entities to the entity group; entities already in the group are unaffected.
- [Remove entities from a group](https://docs.mentionlab.io/api-reference/entity-groups/remove-entities-from-a-group.md): Removes the given entities from the entity group; entities not currently in the group are unaffected.
- [List source categories](https://docs.mentionlab.io/api-reference/source-categories/list-source-categories.md): Returns the global source-category catalog (the taxonomy leaves) for use as manual override options, ordered by label.
- [Get full detail for a single run](https://docs.mentionlab.io/api-reference/job-executions/get-full-detail-for-a-single-run.md): Returns the full detail of one run — its AI response citations, mentioned entities with sentiment and run metadata; a run with no stored response (pending or failed) is treated as not found.
- [Get per-entity visibility scores](https://docs.mentionlab.io/api-reference/analytics--visibility/get-per-entity-visibility-scores.md): Returns aggregated visibility metrics per entity over the selected date range, sorted by visibility descending, suitable for a leaderboard or comparison table.
- [Get brand share of voice](https://docs.mentionlab.io/api-reference/analytics--visibility/get-brand-share-of-voice.md): Returns each entity's share of voice (its percentage of total brand mentions) over the selected date range, sorted by mention count descending, for comparing against competitors.
- [Per-entity visibility/position/sentiment timeseries](https://docs.mentionlab.io/api-reference/analytics--visibility/per-entity-visibilitypositionsentiment-timeseries.md): Returns a visibility, average-position, mention-count and sentiment timeseries for each tracked entity over the selected date range.
- [Get per-tag visibility summary](https://docs.mentionlab.io/api-reference/analytics--tags/get-per-tag-visibility-summary.md): Returns per-tag visibility for the selected entities, with totals and average position rank, to compare brand visibility across query topics.
- [Get per-tag visibility timeseries matrix](https://docs.mentionlab.io/api-reference/analytics--tags/get-per-tag-visibility-timeseries-matrix.md): Returns a time-bucketed visibility matrix with one point per tag per bucket, to chart how tag visibility trends over time.
- [Get per-tag stats with project brand metrics](https://docs.mentionlab.io/api-reference/analytics--tags/get-per-tag-stats-with-project-brand-metrics.md): Returns per-tag statistics with the project brand's visibility, ranking, sentiment, and share-of-voice metrics for a tag-level performance overview.
- [Get per-tag brand visibility broken down by model](https://docs.mentionlab.io/api-reference/analytics--tags/get-per-tag-brand-visibility-broken-down-by-model.md): Returns a paginated list of tags ranked by project brand visibility, each with a per-model visibility breakdown; narrow to specific tags with `tagIds`.
- [Get citation sources for a specific tag](https://docs.mentionlab.io/api-reference/analytics--tags/get-citation-sources-for-a-specific-tag.md): Returns the top cited source domains for a tag with citation and reach metrics, showing which websites AI models cite most for that topic.
- [Get per-tag brand visibility over time](https://docs.mentionlab.io/api-reference/analytics--tags/get-per-tag-brand-visibility-over-time.md): Returns time-bucketed brand mention count and visibility per tag, to track how the project brand's visibility trends within each topic over time.
- [Entities detected for one or more tags](https://docs.mentionlab.io/api-reference/analytics--tags/entities-detected-for-one-or-more-tags.md): Returns entity breakdowns per tag, each ordered by visibility; pass per-tag `limit` and `sort` to adjust.
- [Execution-tag response presence](https://docs.mentionlab.io/api-reference/analytics--tags/execution-tag-response-presence.md): Returns every execution tag for the project with the percentage of AI responses (matching the filters) that carry that tag.
- [Per-domain citation rate and brand true reach](https://docs.mentionlab.io/api-reference/analytics--sources/per-domain-citation-rate-and-brand-true-reach.md): Returns the project's cited source domains, each with its citation rate, cited page count and the share of those pages that also mention the brand; limited by `size` (default 15, max 50).
- [Citation breakdown by ICANN public suffix (TLD)](https://docs.mentionlab.io/api-reference/analytics--sources/citation-breakdown-by-icann-public-suffix-tld.md): Groups source citations by the ICANN public suffix of the cited domain (e.g. "be", "co.uk", "com"), with citationShare and citationRate per TLD. Useful for slicing sources by country / ccTLD.
- [Source domains with citation & brand-reach metrics](https://docs.mentionlab.io/api-reference/analytics--sources/source-domains-with-citation-&-brand-reach-metrics.md): Returns the project's cited source domains with citation and brand-reach metrics over the selected date range; pass `limit` for a top-N view.
- [Citation breakdown by source type, group, or relationship](https://docs.mentionlab.io/api-reference/analytics--sources/citation-breakdown-by-source-type-group-or-relationship.md): Aggregates the project's in-scope citations along one axis selected by the required `dimension` discriminator: `type` (source-type leaf), `group` (source-type group), or `relationship` (owned/competitor/independent). Returns each bucket's citation count and share.
- [Timeseries of top source domains by citation share](https://docs.mentionlab.io/api-reference/analytics--sources/timeseries-of-top-source-domains-by-citation-share.md): Returns a bucketed timeseries of citation share and rate for the top 5 source domains over the selected date range.
- [Entities found on a specific domain with true reach](https://docs.mentionlab.io/api-reference/analytics--sources/entities-found-on-a-specific-domain-with-true-reach.md): Returns the entities found on pages cited from the given domain with their citation and reach metrics; the path domain id overrides any body value, and an unknown domain returns an empty list.
- [Per-URL drill-down for a specific domain](https://docs.mentionlab.io/api-reference/analytics--sources/per-url-drill-down-for-a-specific-domain.md): Returns a paginated list of the individual URLs cited from the given domain with their citation metrics; the path domain id overrides any body value, and an unknown domain returns an empty page.
- [Queries that cited a specific URL on a domain](https://docs.mentionlab.io/api-reference/analytics--sources/queries-that-cited-a-specific-url-on-a-domain.md): Returns the queries that cited a specific URL on the given domain, ordered by citation count; the path domain id overrides any body value, and an unknown domain or URL returns an empty list.
- [Shopping overview stats](https://docs.mentionlab.io/api-reference/analytics--shopping/shopping-overview-stats.md): Returns headline shopping analytics over the selected date range: shopping coverage (the share of AI responses with shopping results) plus distinct brand, product and merchant counts.
- [Brand visibility in shopping results over time](https://docs.mentionlab.io/api-reference/analytics--shopping/brand-visibility-in-shopping-results-over-time.md): Returns a time-bucketed series of brand visibility within shopping results over the selected date range; when no entities are supplied the project's primary entities are used.
- [List products for a merchant](https://docs.mentionlab.io/api-reference/analytics--shopping/list-products-for-a-merchant.md): Returns products sold by this merchant with prices, ratings, and share.
- [List products with shopping metrics](https://docs.mentionlab.io/api-reference/analytics--shopping/list-products-with-shopping-metrics.md): Returns a paginated, sortable list of products mentioned in shopping AI responses for the project, with visibility, pricing and rating metrics and their top merchants.
- [List brands with shopping metrics](https://docs.mentionlab.io/api-reference/analytics--shopping/list-brands-with-shopping-metrics.md): Returns a paginated, sortable list of brands appearing in shopping AI responses for the project, with product count, visibility, pricing metrics, top merchants and share of voice.
- [List merchants with citation metrics](https://docs.mentionlab.io/api-reference/analytics--shopping/list-merchants-with-citation-metrics.md): Returns a paginated, sortable list of merchants cited in shopping AI responses for the project, with citation and offer-quality metrics across all merchants, plus reach metrics scoped to the requested brands.
- [Get overall sentiment for project brand](https://docs.mentionlab.io/api-reference/analytics--sentiment/get-overall-sentiment-for-project-brand.md): Returns the project brand's overall sentiment over the filtered mentions: average score (0-100), derived label, total mentions, and positive/neutral/negative counts.
- [Get sentiment over time](https://docs.mentionlab.io/api-reference/analytics--sentiment/get-sentiment-over-time.md): Returns the project brand's sentiment over time, one point per bucket in chronological order with its average score, positive/neutral/negative mention counts and presentIn (distinct AI responses). mentionCount is deprecated and mirrors presentIn until it is removed.
- [Get sentiment comparison across entities](https://docs.mentionlab.io/api-reference/analytics--sentiment/get-sentiment-comparison-across-entities.md): Returns sentiment per entity (optionally grouped), sorted by mention count descending.
- [Get source domains for a single query](https://docs.mentionlab.io/api-reference/analytics--queries/get-source-domains-for-a-single-query.md): Returns the source domains cited in AI responses for a single query with their citation metrics, ordered by citation count; the body filters by date range, models and tags.
- [Get entity stats for a single query](https://docs.mentionlab.io/api-reference/analytics--queries/get-entity-stats-for-a-single-query.md): Returns the entities detected for a single query (brand, competitors and others) with visibility, share of voice, ranking and sentiment, ordered by presence; the body filters by date range, models, entity types and tags.
- [Get top sources grouped by model for a single query](https://docs.mentionlab.io/api-reference/analytics--queries/get-top-sources-grouped-by-model-for-a-single-query.md): Returns the top 5 cited source domains for each AI model that answered the query, to compare which sources different models prefer; the body filters by date range, models and tags.
- [List AI responses for a query](https://docs.mentionlab.io/api-reference/analytics--queries/list-ai-responses-for-a-query.md): Returns a paginated list of the individual AI responses for a single query, including the response text, model, citations and mentioned entities; the body filters by date range, models and tags.
- [Per-query statistics](https://docs.mentionlab.io/api-reference/analytics--queries/per-query-statistics.md): Returns per-query statistics for the project; to fetch a single query, pass `queryIds: [id]` and read `queries[0]`.
- [Get entity visibility breakdown per AI model](https://docs.mentionlab.io/api-reference/analytics--models/get-entity-visibility-breakdown-per-ai-model.md): Returns a matrix of entities by AI model where each cell is the percentage of that model's responses that mention the entity; use `entityTypes` to limit which entities are included.
- [Get platform details (visibility, ranking, share of voice) per AI model](https://docs.mentionlab.io/api-reference/analytics--models/get-platform-details-visibility-ranking-share-of-voice-per-ai-model.md): Returns one row per AI model summarising the selected entities' visibility, average ranking, mention count and share of voice, ordered by total responses descending.
- [Get top entities for a specific AI model](https://docs.mentionlab.io/api-reference/analytics--models/get-top-entities-for-a-specific-ai-model.md): Drills into a single AI model and returns every detected entity with its visibility, share of voice, mention count and average ranking, ordered by visibility descending.
- [Get top sources for a specific AI model](https://docs.mentionlab.io/api-reference/analytics--models/get-top-sources-for-a-specific-ai-model.md): Drills into a single AI model and returns its most cited source domains with their result count, citation rate and page count, ordered by result count descending.
- [Per-AI-model metric timeseries](https://docs.mentionlab.io/api-reference/analytics--models/per-ai-model-metric-timeseries.md): Returns a per-AI-model time series of the chosen metric (citation, share of voice, position, or visibility) bucketed by `bucketSize`; for position the value is an average rank (lower is better), for the others a percentage (higher is better).
- [Get super-themes with their member themes (Brand Intelligence)](https://docs.mentionlab.io/api-reference/analytics--themes/get-super-themes-with-their-member-themes-brand-intelligence.md): Returns the mutable top grouping: each super-theme (a box) with its member themes, every theme carrying mention count + sentiment so the UI can colour the chips. Super-theme sentiment is the mention-weighted average of its themes. All standard analytics filters apply.
- [Get a paginated page of per-theme aggregates (Brand Perception & Intelligence)](https://docs.mentionlab.io/api-reference/analytics--themes/get-a-paginated-page-of-per-theme-aggregates-brand-perception-&-intelligence.md): Returns ONE PAGE of the project theme taxonomy (each theme with mention count, sentiment split, average sentiment and share of total) plus a full-set summary (totals, unaffected by paging/bias) for the overview. Pass perceptionOnly=true for Brand Perception (themes from perception-type questions onl…
- [Get per-brand stance distribution (Brand Intelligence)](https://docs.mentionlab.io/api-reference/analytics--themes/get-per-brand-stance-distribution-brand-intelligence.md): Returns each brand mentioned in scope with its stance distribution (chosen / mentioned / named / negative_mentioned / negative_named) from EntityMentions.stance, plus total mentions for ranking. The five buckets are exclusive. Pass entityId to narrow to one brand. All standard analytics filters appl…
- [Get the theme × brand sentiment matrix (Brand Intelligence)](https://docs.mentionlab.io/api-reference/analytics--themes/get-the-theme-×-brand-sentiment-matrix-brand-intelligence.md): One cell per (canonical theme, brand) with mention count and sentiment split, over brand-attributed theme mentions across all questions. The client pivots these into a themes-rows × brands-columns grid. All standard analytics filters apply.
- [Drill into a theme: its individual mentions with evidence spans](https://docs.mentionlab.io/api-reference/analytics--themes/drill-into-a-theme:-its-individual-mentions-with-evidence-spans.md): Returns the individual theme_mentions behind one canonical theme — each with its verbatim evidence span, sentiment, strength and a link to the source AI response. Pass entityId to scope to one brand, sentiment to filter. Paginated, central/supporting first then most recent. All standard analytics fi…
- [Drill into a brand stance: the AI responses where it was chosen/negatively mentioned/…](https://docs.mentionlab.io/api-reference/analytics--themes/drill-into-a-brand-stance:-the-ai-responses-where-it-was-chosennegatively-mentioned….md): Returns the AI responses where one brand earned a given stance (e.g. negative_mentioned), each with its full text and the brand’s theme evidence inside it (the why). entityId is expanded to its merge family. Paginated, most recent first. All standard analytics filters apply.
- [Fetch one AI response’s full text (for the in-context evidence viewer)](https://docs.mentionlab.io/api-reference/analytics--themes/fetch-one-ai-response’s-full-text-for-the-in-context-evidence-viewer.md): Returns the full text + minimal context of a single AI response (project-scoped) so a drill-down can highlight an evidence span in its original answer.
- [Get per-brand ad share](https://docs.mentionlab.io/api-reference/analytics--ads/get-per-brand-ad-share.md): Returns each advertised brand's share of sponsored ad placements (its ad cards over all ad cards in scope), with the ad rate and response totals for the filtered scope; honors the active filters.
- [Get ad placement mix by card format](https://docs.mentionlab.io/api-reference/analytics--ads/get-ad-placement-mix-by-card-format.md): Returns the share of sponsored ad placements per card format (provider-defined open set, e.g. 'product_card_v2', 'image_card_v2'); honors the active filters.
- [Get per-advertiser ad share](https://docs.mentionlab.io/api-reference/analytics--ads/get-per-advertiser-ad-share.md): Returns each advertiser's share of sponsored ad placements (who paid for the slot, often a retailer; raw provider labels, never entity-resolved), with the ad rate and response totals for the filtered scope; honors the active filters.
- [Top fan-outs by occurrence](https://docs.mentionlab.io/api-reference/analytics--fan-outs/top-fan-outs-by-occurrence.md): Returns the most common follow-up queries ranked by occurrence count.
- [Fan-outs overview stats](https://docs.mentionlab.io/api-reference/analytics--fan-outs/fan-outs-overview-stats.md): Returns summary fan-out statistics for the project, including total and unique fan-outs and the average number per AI response.
- [Fan-out stats per query](https://docs.mentionlab.io/api-reference/analytics--fan-outs/fan-out-stats-per-query.md): Per-query fan-out statistics across the project.
- [Fan-outs for a specific query](https://docs.mentionlab.io/api-reference/analytics--fan-outs/fan-outs-for-a-specific-query.md): Returns the individual fan-out texts for a single query; the path `queryId` overrides any value in the body.
- [List YouTube videos cited in scope](https://docs.mentionlab.io/api-reference/analytics--social/list-youtube-videos-cited-in-scope.md): Returns a paginated list of YouTube videos cited by AI responses in the selected scope, with per-video citation metrics; pass `channelId` to drill down to a single channel.
- [List YouTube channels cited in scope](https://docs.mentionlab.io/api-reference/analytics--social/list-youtube-channels-cited-in-scope.md): Returns a paginated list of YouTube channels cited by AI responses in the selected scope, with citation metrics aggregated across each channel's cited videos.
- [List YouTube performance by channel country](https://docs.mentionlab.io/api-reference/analytics--social/list-youtube-performance-by-channel-country.md): Returns a paginated breakdown of YouTube citation performance by each cited channel's country; channels with no country are grouped together.
- [KPI summary for YouTube social in scope](https://docs.mentionlab.io/api-reference/analytics--social/kpi-summary-for-youtube-social-in-scope.md): Returns a compact KPI summary of YouTube social activity in the selected scope.
- [Timeseries of top 5 YouTube channels by citation share](https://docs.mentionlab.io/api-reference/analytics--social/timeseries-of-top-5-youtube-channels-by-citation-share.md): Returns a day/week/month timeseries of the top 5 YouTube channels by citation share, with every channel present in each bucket (0 when absent).
- [Queries that cited a specific YouTube video](https://docs.mentionlab.io/api-reference/analytics--social/queries-that-cited-a-specific-youtube-video.md): Returns the queries whose AI responses cited the given YouTube video in the selected scope; the path `videoId` overrides any value in the body.
- [Preview the sources a topic extraction would hit](https://docs.mentionlab.io/api-reference/source-topics/preview-the-sources-a-topic-extraction-would-hit.md): Runs the exact same source selection as the extraction trigger — the top sources (by citation count) matching the standard analytics filters — but enqueues nothing. Returns the selected sources grouped by domain so the frontend can let the user assess the scope before triggering.
- [Trigger topic extraction for the sources in scope](https://docs.mentionlab.io/api-reference/source-topics/trigger-topic-extraction-for-the-sources-in-scope.md): Selects the top 1000 source pages (deduped per url + month, ranked by citation count) matching the standard analytics filters (date range, countries, languages, models, queries, tags) and enqueues their cached page metadata (title + description) for vectorization into the source-topics vector store.…
- [List topic-extraction runs for the project](https://docs.mentionlab.io/api-reference/source-topics/list-topic-extraction-runs-for-the-project.md): Returns the projects topic-extraction runs, most recent first, with their status and progress counters. Poll this (or the per-run endpoint) to drive a loading indicator.
- [Get a single topic-extraction run](https://docs.mentionlab.io/api-reference/source-topics/get-a-single-topic-extraction-run.md): Returns the status and progress counters of one topic-extraction run. Use processed / totalSources for a progress bar.
- [Delete a topic-extraction run](https://docs.mentionlab.io/api-reference/source-topics/delete-a-topic-extraction-run.md): Removes a run from the project run history (soft delete). The run no longer appears in the list or single-run endpoints. Any vectors it produced remain in the store.
- [List the topics extracted for a run](https://docs.mentionlab.io/api-reference/source-topics/list-the-topics-extracted-for-a-run.md): Returns the topics (density clusters of the embedded source metadata, named by an LLM) for a run, biggest first. Topics are produced automatically once embedding completes — poll the run until its `topicsStatus` is `ready`, then read them here. Empty while clustering is pending/running or when no de…
- [Content gap for a run (all topics)](https://docs.mentionlab.io/api-reference/source-topics/content-gap-for-a-run-all-topics.md): Crosses the run’s topics with the source classification: per topic, whether the project’s owned entity has content on it (present = covered, absent = content gap), whether competitors do, the topic’s citation share, and its "ownable" (controllability) source mix. Ordered by citation share descending…
- [Content-gap detail for one topic (its sources)](https://docs.mentionlab.io/api-reference/source-topics/content-gap-detail-for-one-topic-its-sources.md): Lists every source (cited page snapshot) grouped in the topic, each with whether it’s the project’s own content (“is my brand present”), its relationship + controllability + source-type category, the queries it was cited from, and its citation count — sorted most-cited first.
- [Provider/model restrictions (allowed countries)](https://docs.mentionlab.io/api-reference/reference/providermodel-restrictions-allowed-countries.md): Returns the list of provider/model entries with the countries each one is allowed to be used in; this is global reference data shared across all projects.
- [Supported countries and languages allowlist](https://docs.mentionlab.io/api-reference/reference/supported-countries-and-languages-allowlist.md): Returns the allowlist of countries and languages that queries may target; this is global reference data shared across all projects.
- [List shopping products with merchant URLs](https://docs.mentionlab.io/api-reference/shopping-products/list-shopping-products-with-merchant-urls.md): Returns a paginated list of the project's shopping products with their brand details and merchant URLs, filterable by brand, product, name search and external id.

## OpenAPI Specs

- [docs-json](https://api.mentionlab.io/api/docs-json)

## Optional

- [Status](https://status.mentionlab.io)