> ## Documentation Index > Fetch the complete documentation index at: https://docs.mentionlab.io/llms.txt > Use this file to discover all available pages before exploring further. # Get brand share of voice > 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. ## OpenAPI ````yaml https://api.mentionlab.io/api/docs-json post /api/analytics/visibility/share-of-voice openapi: 3.0.0 info: title: MentionLab Public API v0.3.4-rc description: '' version: 0.3.4-rc contact: {} servers: - url: https://api.mentionlab.io security: [] tags: [] paths: /api/analytics/visibility/share-of-voice: post: tags: - Analytics - Visibility summary: Get brand share of voice description: >- 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. operationId: VisibilityController_getShareOfVoice parameters: - name: x-project-id in: header description: Project ID to specify the project context required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ShareOfVoiceDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ShareOfVoiceResponse' '400': description: >- The request failed validation — the body, query or path parameters are malformed or out of range. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '401': description: The request is missing valid authentication credentials. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' '403': description: >- The authenticated principal lacks the required permission, or access to the requested organisation/project. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' components: schemas: ShareOfVoiceDto: type: object properties: startDate: type: string description: Start date (inclusive) example: '2025-01-01' endDate: type: string description: End date (exclusive) example: '2025-02-01' countries: description: Filter by country codes example: - BE - FR type: array items: type: string languages: description: Filter by language codes example: - en - fr type: array items: type: string models: description: Filter by AI models example: - gpt-4o - claude-3-5-sonnet type: array items: type: string queryIds: description: Filter by query IDs example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string hasSources: type: string description: >- Filter by source presence: "sources" (only with sources), "no_sources" (only without), "all" (no filter). Legacy true/false values are still accepted. enum: - all - sources - no_sources hasShopping: type: string description: >- Filter by shopping presence: "shopping" (only with shopping), "no_shopping" (only without), "all" (no filter). Legacy true/false values are still accepted. enum: - all - shopping - no_shopping queryTagIds: description: Filter by query tag IDs (numeric — bigint column) example: - '42' type: array items: type: string execTagIds: description: Filter by execution tag IDs example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string queryTagGroupIds: description: >- Filter by query tag group IDs — matches rows carrying any tag filed under a selected group. Combines with queryTagIds per queryTagMode. example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string execTagGroupIds: description: >- Filter by execution tag group IDs — matches rows carrying any tag filed under a selected group. Combines with execTagIds per execTagMode. example: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: array items: type: string queryTypes: type: array description: >- Filter by query type. Include "untyped" to also match queries without a type. Results from since-deleted queries are excluded when this filter is set. items: type: string enum: - comparative - informative - perception - untyped queryTagMode: type: string description: >- Query tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags. enum: - and - or default: or execTagMode: type: string description: >- Execution tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags. enum: - and - or default: or timezone: type: string description: >- IANA timezone for date bucketing and filtering (e.g. "Europe/Brussels"). Defaults to UTC. example: Europe/Brussels default: UTC groupBy: type: string description: >- Row grouping level for entity results. "none" = one row per entity, "division" = one row per division (entities not in a division get their own row), "group" = one row per top-level group (divisions roll up into their group). Defaults to "none". enum: - none - division - group groupByEntityGroup: type: boolean description: >- Deprecated — use groupBy instead. true is equivalent to groupBy="group". deprecated: true example: false showAllEntities: type: boolean description: >- Include entities that have only ever been seen in a single AI response. These are mostly one-off extraction noise and are hidden by default. example: false entityTypes: type: array description: >- Filter which entity types to include in results. Accepted values: "owned", "primary", "competitor". Defaults to all types when omitted. example: - owned - primary - competitor items: type: string enum: - owned - primary - competitor ShareOfVoiceResponse: type: object properties: totalMentions: type: number description: >- Sum of mentionCount across all non-blacklisted canonical entities (denominator for shareOfVoice). Because one AI response can mention multiple entities, this may exceed the total number of AI responses. example: 150 brands: description: >- Per-entity share of voice, sorted by mentionCount descending. Includes all non-blacklisted canonical entities for the project. type: array items: $ref: '#/components/schemas/ShareOfVoicePoint' required: - totalMentions - brands ApiErrorResponse: type: object properties: statusCode: type: number description: HTTP status code of the error. example: 400 message: type: string description: >- Human-readable description of the error. Validation failures return an array of per-field validation errors instead of a single string. example: Validation failed error: type: string description: Short name of the HTTP error. example: Bad Request required: - statusCode ShareOfVoicePoint: type: object properties: displayKey: type: string description: Canonical entity ID. example: 550e8400-e29b-41d4-a716-446655440000 displayName: type: string description: Human-readable entity name. example: Acme Corp isOwned: type: boolean description: >- Whether this entity is owned by the project (i.e. the project's own brand or product). example: true isPrimary: type: boolean description: Whether this entity is the primary (main) entity for the project. example: true mentionCount: type: number description: >- Number of AI responses that mention this entity (after canonical deduplication). Used as the numerator for shareOfVoice. example: 42 shareOfVoice: type: number description: >- Share of voice — this entity's portion of all entity mentions. Formula: (mentionCount / totalMentions) × 100. Values across all entities sum to 100%. Note: a single AI response mentioning 3 entities contributes to all 3, so totalMentions may exceed the number of AI responses. example: 28 required: - displayKey - displayName - isOwned - isPrimary - mentionCount - shareOfVoice ````