Skip to main content
POST
/
api
/
analytics
/
tags
/
stats
Get per-tag stats with project brand metrics
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/tags/stats \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "tagType": "query",
  "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",
  "entityIds": [
    "<string>"
  ],
  "tagIds": [
    "<string>"
  ],
  "groupByEntityGroup": false
}
'
{
  "tags": [
    {
      "tagId": "550e8400-e29b-41d4-a716-446655440000",
      "tagName": "Pricing",
      "tagColor": "#4f46e5",
      "resultCount": 340,
      "projectBrand": {
        "mentionCount": 80,
        "visibility": 40,
        "avgRanking": 2.5,
        "sentimentScore": 72.3,
        "shareOfVoice": 32.1,
        "sentimentPositive": 52,
        "sentimentNeutral": 18,
        "sentimentNegative": 10
      }
    }
  ]
}

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"

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

Entity IDs for the project brand (defaults to primary non-blacklisted)

tagIds
string[]

Restrict to specific tag IDs (omit for all tags)

groupByEntityGroup
boolean
default:false

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

Response

200 - application/json
tags
object[]
required

Per-tag overview statistics with project brand metrics, one entry per tag.