Skip to main content
GET
/
ai-analytics-service
/
api
/
public
/
v1
/
sentiment
/
competitive-brand
/
mentions
Get Competitive Brand Sentiment
curl --request GET \
  --url https://api.slatehq.ai/ai-analytics-service/api/public/v1/sentiment/competitive-brand/mentions \
  --header 'Authorization: <authorization>'
{
  "brands": [
    {
      "brandName": "<string>",
      "positiveSentiment": 123,
      "neutralSentiment": 123,
      "negativeSentiment": 123,
      "topPositiveKeyword": "<string>",
      "topPositiveKeywordCount": 123,
      "topPositiveKeywordThemeId": "<string>",
      "topPositiveKeywordId": "<string>",
      "topNegativeKeyword": "<string>",
      "topNegativeKeywordCount": 123,
      "topNegativeKeywordThemeId": "<string>",
      "topNegativeKeywordId": "<string>"
    }
  ]
}

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 sentiment data grouped by competing brand. Each brand entry includes positive, neutral, and negative mention counts along with the top positive and negative keywords driving sentiment.

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.
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 an array of brand sentiment objects.
brands
object[]
required
Array of brand sentiment objects.

Example

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

Response

[
  {
    "brandName": "MyBrand",
    "positiveSentiment": 85,
    "neutralSentiment": 45,
    "negativeSentiment": 12,
    "topPositiveKeyword": "ease of use",
    "topPositiveKeywordCount": 28,
    "topPositiveKeywordThemeId": "theme-abc-123",
    "topPositiveKeywordId": "kw-001",
    "topNegativeKeyword": "pricing",
    "topNegativeKeywordCount": 8,
    "topNegativeKeywordThemeId": "theme-def-456",
    "topNegativeKeywordId": "kw-010"
  },
  {
    "brandName": "CompetitorA",
    "positiveSentiment": 60,
    "neutralSentiment": 50,
    "negativeSentiment": 20,
    "topPositiveKeyword": "integration options",
    "topPositiveKeywordCount": 15,
    "topPositiveKeywordThemeId": "theme-abc-123",
    "topPositiveKeywordId": "kw-003",
    "topNegativeKeyword": "learning curve",
    "topNegativeKeywordCount": 12,
    "topNegativeKeywordThemeId": "theme-ghi-789",
    "topNegativeKeywordId": "kw-015"
  }
]

Status codes

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

What’s next