API
Sentiment
Net Sentiment Score aggregates per brand, engine, and measurement window.
GET /api/v1/sentiment returns Brand Perception aggregates: for each
measurement window, brand, and engine, the sentiment counts across that
window's answers and the resulting Net Sentiment Score. The attribute side
of perception lives in attributes and
attribute mentions.
Filters
| Parameter | Meaning |
|---|---|
measurement_window_id | Restrict to one window. |
brand_id | Restrict to one brand (yours or a competitor). |
engine_id | Restrict to one engine. |
Standard parameters (limit, offset, format=csv) work as described in
Pagination, filtering, and errors.
Key fields
measurement_window_id: joinable to measurement windowsbrand_id: the brand the row scores, joinable to brandsengine_id: the engine whose answers were classifiedpositive_count/neutral_count/negative_count: classified brand mentions in the windowcaveat_count: mentions that praise with a reservationmention_count: total classified mentions behind the rownss: Net Sentiment Score, from -100 to 100, mention-weightedavg_confidence: average classification confidence, 0 to 1
Rows are ordered by measurement_window_id descending with brand_id and
engine_id as tiebreaks, so offset pagination is stable.
Example
curl -H "Authorization: Bearer $AEO_API_KEY" \
"https://app.citlyze.com/api/v1/sentiment?brand_id=$BRAND_ID"Use this resource to trend how AI answers talk about each brand over time and to compare tone across engines and against competitors.