Skip to main content
POST
/
api
/
analytics
/
sentiment
/
overview
Get overall sentiment for project brand
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/sentiment/overview \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "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": [
    "3f8b1c2a-9d4e-4f6a-8b1c-2a9d4e4f6a8b"
  ]
}
'
{
  "sentimentScore": 72.3,
  "sentimentLabel": "positive",
  "mentionCount": 245,
  "positive": 165,
  "neutral": 52,
  "negative": 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"

​
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 sentiment for. Defaults to project brand (primary non-blacklisted).

Example:
["3f8b1c2a-9d4e-4f6a-8b1c-2a9d4e4f6a8b"]

Response

​
sentimentScore
number
required

Average sentiment score (0–100). 0 = most negative, 100 = most positive.

Example:

72.3

​
sentimentLabel
string
required

Derived sentiment label based on score: positive (>= 60), neutral (40–59), negative (< 40).

Example:

"positive"

​
mentionCount
number
required

Total mention count included in the aggregation.

Example:

245

​
positive
number
required

Count of mentions with positive sentiment.

Example:

165

​
neutral
number
required

Count of mentions with neutral sentiment.

Example:

52

​
negative
number
required

Count of mentions with negative sentiment.

Example:

28