Skip to main content
POST
/
api
/
analytics
/
visibility
/
share-of-voice
Get brand share of voice
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/visibility/share-of-voice \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "startDate": "2025-01-01",
  "endDate": "2025-02-01",
  "country": "<string>",
  "language": "<string>",
  "models": [
    "<string>"
  ],
  "hasSources": true,
  "hasShopping": true,
  "queryTagIds": [
    "<string>"
  ],
  "execTagIds": [
    "<string>"
  ],
  "queryTagMode": "or",
  "execTagMode": "or",
  "groupByEntityGroup": false,
  "entityTypes": [
    "owned",
    "primary",
    "competitor"
  ]
}
'
{
  "totalMentions": 150,
  "brands": [
    {
      "displayKey": "550e8400-e29b-41d4-a716-446655440000",
      "displayName": "Acme Corp",
      "isOwned": true,
      "isPrimary": true,
      "mentionCount": 42,
      "shareOfVoice": 28
    }
  ]
}

Headers

​
x-project-id
string
required

Project ID to specify the project context

Body

application/json
​
startDate
string

Start date (inclusive)

Example:

"2025-01-01"

​
endDate
string

End date (exclusive)

Example:

"2025-02-01"

​
country
string

Filter by country code

​
language
string

Filter by language code

​
models
string[]

Filter by AI models

​
hasSources
boolean

Filter by responses that have sources

​
hasShopping
boolean

Filter by responses that have shopping products

​
queryTagIds
string[]

Filter by query tag IDs

​
execTagIds
string[]

Filter by execution tag IDs

​
queryTagMode
enum<string>
default:or

Query tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags.

Available options:
and,
or
​
execTagMode
enum<string>
default:or

Execution tag matching mode: "or" matches ANY tag (default), "and" matches ALL tags.

Available options:
and,
or
​
groupByEntityGroup
boolean
default:false

Collapse entities by entity_group (uses COUNT DISTINCT ai_response_id)

​
entityTypes
enum<string>[]

Filter which entity types to include in results. Accepted values: "owned", "primary", "competitor". Defaults to all types when omitted.

Available options:
owned,
primary,
competitor
Example:
["owned", "primary", "competitor"]

Response

200 - application/json
​
totalMentions
number
required

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
object[]
required

Per-entity share of voice, sorted by mentionCount descending. Includes all non-blacklisted canonical entities for the project.