StatsResponse
Response containing aggregated statistics for an account or alert.
ID of the account these stats belong to
ID of the alert these stats belong to (if filtered by alert)
Time period grouping: hour, day, week, or month
Start date for the statistics range (ISO 8601 or YYYY-MM-DD)
End date for the statistics range (ISO 8601 or YYYY-MM-DD)
List of StatsData objects for each periodShow StatsData properties
Period identifier (e.g., “2026-03-04” for daily stats)
Number of mentions in this period
Total reach in this period
Number of positive mentions
Number of negative mentions
Number of neutral mentions
List of SourceStats objectsShow SourceStats properties
Source name (e.g., “twitter”, “news”)
Number of mentions from this source
Positive mentions from this source
Negative mentions from this source
Neutral mentions from this source
Total mentions across all periods
Total reach across all periods
Sentiment breakdown with counts for positive, negative, and neutral
Source breakdown with mention counts per source
StatsPeriod Enum
Available time periods for grouping statistics:
hour - Group by hourday - Group by dayweek - Group by weekmonth - Group by month
Example
{
"account_id": "acc_1234567890",
"alert_id": "alert_1234567890",
"period": "day",
"from_date": "2026-03-01",
"to_date": "2026-03-04",
"data": [
{
"period": "2026-03-01",
"mentions_count": 45,
"reach": 125000,
"sentiment_positive": 32,
"sentiment_negative": 5,
"sentiment_neutral": 8,
"sources": [
{
"source": "twitter",
"mentions_count": 28,
"reach": 85000,
"sentiment_positive": 20,
"sentiment_negative": 3,
"sentiment_neutral": 5
},
{
"source": "news",
"mentions_count": 17,
"reach": 40000,
"sentiment_positive": 12,
"sentiment_negative": 2,
"sentiment_neutral": 3
}
]
},
{
"period": "2026-03-02",
"mentions_count": 38,
"reach": 98000,
"sentiment_positive": 25,
"sentiment_negative": 7,
"sentiment_neutral": 6,
"sources": [
{
"source": "twitter",
"mentions_count": 22,
"reach": 62000,
"sentiment_positive": 15,
"sentiment_negative": 4,
"sentiment_neutral": 3
}
]
}
],
"total_mentions": 147,
"total_reach": 485000,
"sentiment_distribution": {
"positive": 98,
"negative": 22,
"neutral": 27
},
"sources_distribution": {
"twitter": 89,
"news": 35,
"blog": 23
}
}
Request Models
StatsRequest
Used when requesting statistics data.
Start date for the statistics range (ISO 8601 or YYYY-MM-DD)
End date for the statistics range (ISO 8601 or YYYY-MM-DD)
Time period grouping: hour, day, week, or month
Optional field to group by (e.g., “source”, “sentiment”)