PSpscrpt
metrics

Query subscriber statistics

Changed on

Aggregate list growth for SMS and email: subscribe and unsubscribe events per bucket, net change, the active subscriber count at each bucket's end, and optionally the acquisition method (and raw consent source) behind the subscribes. The same readers as the dashboard's List Growth page. Buckets are UTC days, Monday weeks or calendar months; timezone is always UTC. Without channel in group_by, two channels are read as one combined list (channel: all). A query is not a mutation and takes no Idempotency-Key.

post/subscriber-stats

Request

  • Base URL
    https://api.pscrpt.com/v1
  • URL
    https://api.pscrpt.com/v1/subscriber-stats
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.pscrpt.com/oauth/authorize
      Token URL: https://api.pscrpt.com/oauth/token scopes: metrics:read

Headers

Postscript-Versionstring date
Example:2026-07-23

Overrides the key's pinned API revision for this request.

Request body

channelsSubscriberStatsChannel[]

Default — both.

group_bySubscriberStatsDimension[]
interval'day' | 'week' | 'month'

UTC calendar buckets; weeks start Monday. The first bucket may open before timeframe.gte.

Example request

{
  "timeframe": {
    "gte": "2026-07-23T17:32:01.123456Z",
    "lte": "2026-07-23T17:32:01.123456Z"
  }
}

Response

Per-bucket subscriber flows and active counts, optional source breakdown, and window totals.

Example response

{
  "data": {
    "series": [
      {
        "bucket_start": "2026-07-23T17:32:01.123456Z"
      }
    ],
    "sources": [
      {
        "bucket_start": "2026-07-23T17:32:01.123456Z",
        "method": "checkout"
      }
    ],
    "timeframe": {
      "gte": "2026-07-23T17:32:01.123456Z",
      "lte": "2026-07-23T17:32:01.123456Z"
    }
  }
}

Changes