Skip to main content
POST
/
api
/
analytics
/
sentiment
/
by-entity
Get sentiment comparison across entities
curl --request POST \
  --url https://api.mentionlab.io/api/analytics/sentiment/by-entity \
  --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>"
  ]
}
'
[
  {
    "displayKey": "550e8400-e29b-41d4-a716-446655440000",
    "displayName": "Acme Corp",
    "isOwned": true,
    "isPrimary": true,
    "isCompetitor": false,
    "sentimentScore": 72.3,
    "positive": 52,
    "neutral": 18,
    "negative": 10,
    "mentionCount": 80
  }
]

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"

​
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[]

Scope to specific entity IDs. If omitted, returns all non-blacklisted entities.

Response

200 - application/json
​
displayKey
string
required

Canonical entity ID.

Example:

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

​
displayName
string
required

Entity display name.

Example:

"Acme Corp"

​
isOwned
boolean
required

Whether the entity is owned by the project.

Example:

true

​
isPrimary
boolean
required

Whether this is the primary project entity.

Example:

true

​
isCompetitor
boolean
required

Whether this is a competitor entity.

Example:

false

​
sentimentScore
number
required

Average sentiment score (0–100).

Example:

72.3

​
positive
number
required

Count of positive-sentiment mentions.

Example:

52

​
neutral
number
required

Count of neutral-sentiment mentions.

Example:

18

​
negative
number
required

Count of negative-sentiment mentions.

Example:

10

​
mentionCount
number
required

Total mention count for this entity.

Example:

80