Statistics
Get Subscriber Metrics
Get subscriber metrics including total, new, renewed, paid, and free subscriptions for a specified timeframe. unknown_subscriptions indicates deleted fan accounts.
get/api/{account}/statistics/subscriber-metrics
Query parameters
start_datestring required
The start date for the metrics.
Example:2025-01-01 00:00:00
The start date for the metrics.
end_datestring required
The end date for the metrics.
Example:2025-03-31 23:59:59
The end date for the metrics.
detailedboolean nullable
Include paid and free fan metrics. Will slow down the response time, and might time out if timeframe is too large. Default = false
Include paid and free fan metrics. Will slow down the response time, and might time out if timeframe is too large. Default = false
Response
Example response
{
"data": {
"total_subscriptions": 10,
"new_subscriptions": 5,
"renewed_subscriptions": 5,
"detailed": {
"paid_subscriptions": 7,
"free_subscriptions": 2,
"unknown_subscriptions": 1
}
},
"_meta": {
"_credits": {
"used": 1,
"balance": 999999227,
"note": "Always"
},
"_cache": {
"is_cached": false,
"note": "Cache disabled for this endpoint"
},
"_rate_limits": {
"limit_minute": 1000,
"limit_day": 50000,
"remaining_minute": 998,
"remaining_day": 49952
}
}
}