Skip to main content
POST
/
api
/
analytics
/
queries
/
{queryId}
/
stats
Get aggregate stats for a single query
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/queries/{queryId}/stats \
  --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"
  ],
  "entityIds": [
    "<string>"
  ]
}
'
{
  "resultCount": 42,
  "visibilityPct": 67,
  "avgSentiment": 72.3,
  "sourcePresencePct": 85,
  "shoppingPresencePct": 23,
  "avgRanking": 2.3
}

Headers

​
x-project-id
string
required

Project ID to specify the project context

Path Parameters

​
queryId
string
required

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

When true, entities belonging to the same entity_group are collapsed into a single row. Uses COUNT(DISTINCT ai_response_id) so that two group members present in the same response count as one (visibility cannot exceed 100%).

​
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.

Response

200 - application/json
​
resultCount
number
required

Total AI responses for this query.

Example:

42

​
visibilityPct
number
required

Brand visibility — % of responses mentioning the brand.

Example:

67

​
avgSentiment
object
required

Average sentiment score (0–100). Null if no sentiment data.

Example:

72.3

​
sourcePresencePct
number
required

% of responses that include source citations.

Example:

85

​
shoppingPresencePct
number
required

% of responses that include shopping products.

Example:

23

​
avgRanking
object
required

Average position rank. Null if no position data.

Example:

2.3