Skip to main content
POST
/
api
/
analytics
/
queries
/
{queryId}
/
entities
Get entity stats for a single query
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/queries/{queryId}/entities \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "queryId": "3f8a1c2d-5b6e-4a7f-9c0d-1e2f3a4b5c6d",
  "startDate": "2025-01-01",
  "endDate": "2025-02-01",
  "countries": [
    "BE",
    "FR"
  ],
  "languages": [
    "en",
    "fr"
  ],
  "models": [
    "gpt-4o",
    "claude-3-5-sonnet"
  ],
  "queryIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "queryTagIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "execTagIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "queryTagMode": "or",
  "execTagMode": "or",
  "timezone": "Europe/Brussels",
  "groupByEntityGroup": true,
  "entityTypes": [
    "owned",
    "primary",
    "competitor"
  ],
  "entityIds": [
    "3f8a1c2d-5b6e-4a7f-9c0d-1e2f3a4b5c6d"
  ]
}
'
{
  "totalResponses": 42,
  "entities": [
    {
      "displayKey": "550e8400-e29b-41d4-a716-446655440000",
      "displayName": "Acme Corp",
      "isOwned": true,
      "isPrimary": true,
      "isCompetitor": false,
      "mentionCount": 56,
      "visibility": 67,
      "shareOfVoice": 32.1,
      "avgRanking": 2.5,
      "sentimentScore": 72.3,
      "sentiment": {
        "positive": 35,
        "neutral": 15,
        "negative": 6
      }
    }
  ]
}

Headers

​
x-project-id
string
required

Project ID to specify the project context

Path Parameters

​
queryId
string
required

UUID of the query to retrieve detected entity stats for.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Body

application/json
​
queryId
string
required

Unique identifier of the analytics query to retrieve details for. Populated from the route path parameter, not the request body.

Example:

"3f8a1c2d-5b6e-4a7f-9c0d-1e2f3a4b5c6d"

​
startDate
string

Start date (inclusive)

Example:

"2025-01-01"

​
endDate
string

End date (exclusive)

Example:

"2025-02-01"

​
countries
string[]

Filter by country codes

Example:
["BE", "FR"]
​
languages
string[]

Filter by language codes

Example:
["en", "fr"]
​
models
string[]

Filter by AI models

Example:
["gpt-4o", "claude-3-5-sonnet"]
​
queryIds
string[]

Filter by query IDs

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
hasSources
enum<string>

Filter by source presence: "sources" (only with sources), "no_sources" (only without), "all" (no filter). Legacy true/false values are still accepted.

Available options:
all,
sources,
no_sources
​
hasShopping
enum<string>

Filter by shopping presence: "shopping" (only with shopping), "no_shopping" (only without), "all" (no filter). Legacy true/false values are still accepted.

Available options:
all,
shopping,
no_shopping
​
queryTagIds
string[]

Filter by query tag IDs

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
execTagIds
string[]

Filter by execution tag IDs

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
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
​
timezone
string
default:UTC

IANA timezone for date bucketing and filtering (e.g. "Europe/Brussels"). Defaults to UTC.

Example:

"Europe/Brussels"

​
groupByEntityGroup
boolean
default:false

When true, entities in the same group are collapsed into one row, counted once per response (so visibility cannot exceed 100%).

Example:

true

​
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"]
​
entityIds
string[]

Entity IDs for brand-scoped metrics. Defaults to project brand.

Example:
["3f8a1c2d-5b6e-4a7f-9c0d-1e2f3a4b5c6d"]

Response

​
totalResponses
number
required

Total number of AI responses for this query in the filtered scope (denominator for visibility).

Example:

42

​
entities
object[]
required

All detected entities for this query, ordered by presence (how often they appear in AI responses) descending.