Statistics
Statistics Overview
Get an overview of statistics for fans, visitors, posts, or general.
get/api/{account}/statistics/overview
Query parameters
start_datestring
The start date for the statistics. Keep empty to retrieve from the model's start date.
Example:2025-01-01 00:00:00
The start date for the statistics. Keep empty to retrieve from the model's start date.
end_datestring
The end date for the statistics. Keep empty to retrieve until now.
Example:2025-03-31 23:59:59
The end date for the statistics. Keep empty to retrieve until now.
type'fans' | 'visitors' | 'posts' | 'messages' nullable
The type of statistics to retrieve (default = empty)
Example:fans
The type of statistics to retrieve (default = empty)
Response
Example response
{
"data": {
"earning": {
"total": 123.45,
"gross": 123.45,
"delta": 1.6
},
"posts": {
"hasStatistic": true,
"count": {
"total": 123,
"delta": 0
},
"views": {
"total": 123,
"delta": -7.6
},
"chartData": [
{
"date": "2025-01-01T00:00:00+00:00",
"count": 123
}
],
"earnings": {
"total": 123,
"gross": 123,
"delta": 123
}
},
"streams": {
"hasStatistic": false,
"count": {
"total": "0m",
"delta": 0
},
"views": {
"total": 0,
"delta": 0
},
"chartData": [
{
"date": "2025-01-01T00:00:00+00:00",
"count": 123
}
],
"earnings": {
"total": 123,
"gross": 123,
"delta": 123
}
},
"visitors": {
"hasStatistic": true,
"visitors": {
"total": 0,
"delta": -100
},
"chartData": [
{
"date": "2025-01-01T00:00:00+00:00",
"count": 123
}
],
"earnings": {
"total": 123.45,
"gross": 123.45,
"delta": -10.9
},
"subscriptions": {
"new": {
"total": 123,
"delta": -5.7
},
"renew": {
"total": 123,
"delta": -17
}
}
},
"massMessages": {
"hasStatistic": true,
"count": {
"total": 123,
"delta": 14.5
},
"views": {
"total": 0,
"delta": 0
},
"chartData": [
{
"date": "2025-01-01T00:00:00+00:00",
"count": 123
}
],
"earnings": {
"total": 123.45,
"delta": -0.1,
"gross": 123.45
}
}
},
"_meta": {
"_credits": {
"used": 1,
"balance": 999999254,
"note": "Always"
},
"_cache": {
"is_cached": false,
"note": "Cache disabled for this endpoint"
},
"_rate_limits": {
"limit_minute": 1000,
"limit_day": 50000,
"remaining_minute": 999,
"remaining_day": 49979
}
}
}