Skip to main content
POST
/
api
/
analytics
/
tags
/
summary
Get per-tag visibility summary
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/tags/summary \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "tagType": "query",
  "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",
  "entityIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "groupByEntityGroup": true
}
'
[
  {
    "tagId": "550e8400-e29b-41d4-a716-446655440000",
    "tagName": "Pricing",
    "tagColor": "#FF5733",
    "totalResponses": 200,
    "presentIn": 80,
    "visibilityPct": 40,
    "avgPositionRank": 2.5
  }
]

Headers

​
x-project-id
string
required

Project ID to specify the project context

Body

application/json
​
tagType
enum<string>
required

Which tag system to group by

Available options:
query,
execution
Example:

"query"

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

​
entityIds
string[]

Entity IDs to compute visibility for (defaults to primary non-blacklisted)

Example:
["3fa85f64-5717-4562-b3fc-2c963f66afa6"]
​
groupByEntityGroup
boolean
default:false

When true, expand selected entities to include all members of their entity groups.

Example:

true

Response

​
tagId
string
required

Tag ID (UUID).

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
tagName
string
required

Tag display name.

Example:

"Pricing"

​
tagColor
string
required

Tag color as a hex string.

Example:

"#FF5733"

​
totalResponses
number
required

Total number of AI responses tagged with this tag (denominator for visibilityPct). Scoped by the request filters (project, date range, models, platforms).

Example:

200

​
presentIn
number
required

Number of AI responses (for this tag) where the selected entities are mentioned (numerator for visibilityPct). Counted once per AI response.

Example:

80

​
visibilityPct
number
required

Visibility percentage — how often the selected entities appear in responses tagged with this tag. Formula: (presentIn / totalResponses) × 100.

Example:

40

​
avgPositionRank
number
required

Average position rank for the selected entities within responses tagged with this tag. Lower values mean the entity tends to appear higher/earlier in responses.

Example:

2.5