Skip to main content
GET
Get Competitive Brand Sentiment
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

string
required
Bearer token. Format: Bearer slat_<your-token>.
integer
Number of days for the analysis window. Range: 1–365. Default: 30.
string
Start of date range. RFC 3339 timestamp (e.g., 2026-02-01T00:00:00Z). Send together with to.
string
End of date range. RFC 3339 timestamp. Send together with from. Data through the end of this date (UTC) is included. The range can’t exceed 366 days.
number
Filter by topic ID.
number
Filter by brand ID. If omitted, uses the brand of the workspace’s most recently updated prompt.
string[]
Filter by one or more platforms: CHATGPT, PERPLEXITY, GOOGLE_AI_OVERVIEW, GOOGLE_AI_MODE, GEMINI, CLAUDE.
string
Filter by ISO country code for region.
number
Filter by a single prompt ID.
number[]
Filter by multiple prompt IDs. Maximum 500 values.

Response

Returns 200 OK with a JSON array of brand sentiment objects, most-mentioned brands first. Each object has these fields:
string
required
Name of the mentioned brand.
integer
required
Positive mention count.
integer
required
Neutral mention count.
integer
required
Negative mention count.
string
Most frequent positive keyword for the brand. The four topPositiveKeyword* fields are an empty string (or 0 for the count) when the brand has no positive keywords.
integer
Count of the top positive keyword.
string
Theme ID of the top positive keyword.
string
Keyword ID of the top positive keyword.
string
Most frequent negative keyword for the brand. The four topNegativeKeyword* fields are an empty string (or 0 for the count) when the brand has no negative keywords.
integer
Count of the top negative keyword.
string
Theme ID of the top negative keyword.
string
Keyword ID of the top negative keyword.

Example

Response

Status codes

What’s next