Skip to main content
GET
/
ai-analytics-service
/
api
/
public
/
v1
/
sentiment
/
overall
/
mentions
Get Overall Sentiment
curl --request GET \
  --url https://api.slatehq.ai/ai-analytics-service/api/public/v1/sentiment/overall/mentions \
  --header 'Authorization: <authorization>'
{
  "positiveSentiment": 123,
  "neutralSentiment": 123,
  "negativeSentiment": 123,
  "positiveSentimentDelta": 123,
  "neutralSentimentDelta": 123,
  "negativeSentimentDelta": 123
}

Documentation Index

Fetch the complete documentation index at: https://slatehq.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Returns overall sentiment breakdown for your brand mentions across AI platforms. Includes counts for positive, neutral, and negative sentiment, plus the change (delta) compared to the previous period of equal length.

Parameters

Authorization
string
required
Bearer token. Format: Bearer slat_<your-token>.
dateRange
integer
Number of days for the analysis window.
from
string
Start of date range. ISO 8601 format (e.g., 2026-02-01T00:00:00Z).
to
string
End of date range. ISO 8601 format.
topicId
number
Filter by topic ID.
brandId
number
Filter by brand ID.
brand
string
Filter by brand name.
platform
string[]
Filter by one or more platforms: CHATGPT, PERPLEXITY, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, CLAUDE.
region
string
Filter by ISO country code for region.
promptId
number
Filter by a single prompt ID.
promptIds
number[]
Filter by multiple prompt IDs. Maximum 10 values.

Response

Returns 200 OK with the sentiment summary.
positiveSentiment
integer
required
Count of positive sentiment mentions.
neutralSentiment
integer
required
Count of neutral sentiment mentions.
negativeSentiment
integer
required
Count of negative sentiment mentions.
positiveSentimentDelta
integer
required
Change in positive sentiment compared to the previous period.
neutralSentimentDelta
integer
required
Change in neutral sentiment compared to the previous period.
negativeSentimentDelta
integer
required
Change in negative sentiment compared to the previous period.

Example

curl -s "https://api.slatehq.ai/ai-analytics-service/api/public/v1/sentiment/overall/mentions?dateRange=30&topicId=42" \
  -H "Authorization: Bearer slat_YOUR_TOKEN"

Response

{
  "positiveSentiment": 120,
  "neutralSentiment": 80,
  "negativeSentiment": 15,
  "positiveSentimentDelta": 10,
  "neutralSentimentDelta": -5,
  "negativeSentimentDelta": -2
}
Delta values compare the current period to the previous period of equal length. A positiveSentimentDelta of 10 means 10 more positive mentions than the prior period.

Status codes

StatusDescription
200Sentiment data returned.
400promptIds exceeds maximum of 10 values.
401Missing or invalid Bearer token. See Authentication.
500Internal server error.

What’s next