v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB
Statistics

Get Subscriber Statistics

Get subscriber and earning statistics for an account for a specified timeframe. Optionally, filter by all, renews, or new subscribers.

get/api/{account}/subscribers/statistics

Query parameters

start_datestring nullable

The start date for the period. Keep empty to calculate everything.

Example:2025-01-01 00:00:00

The start date for the period. Keep empty to calculate everything.

end_datestring nullable

The end date for the period. Keep empty to calculate everything.

Example:2025-03-31 23:59:59

The end date for the period. Keep empty to calculate everything.

type'total' | 'renew' | 'new' nullable

Filter the subscriber statistics (default = total)

Example:total

Filter the subscriber statistics (default = total)

Response

Example response

{
  "data": {
    "earnings": [
      {
        "date": "2025-01-01T00:00:00+00:00",
        "count": 12.34
      }
    ],
    "subscribes": [
      {
        "date": "2025-01-01T00:00:00+00:00",
        "count": 123
      }
    ],
    "total": 12.34,
    "delta": 12.3,
    "subscribers": 123
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 999999287,
      "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": 49994
    }
  }
}