---
title: "Subscriber analytics"
method: GET
path: "/v1/analytics/subscribers"
tags: ["Analytics"]
---

# Subscriber analytics

`GET /v1/analytics/subscribers`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/analytics/subscribers`
- Auth: HTTP bearer

New sign-ups, cancellations, churn rate, trial-to-paid conversion and the status distribution of the window. The filter allow-lists do not apply: the figures describe the whole membership of the scope, which is what retention is measured against.

```bash
curl "https://api.subscriby.net/v1/analytics/subscribers?project_id=$PROJECT_ID" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
```

## Query parameters

- `project_id` string, uuid
- `period` string
- `from` string, date
- `to` string, date

## Response `200`

New, canceled, churn, trials and the status mix.

- object
  - `data` object, required: The response's payload.
    - `range` object, required: The window the preset resolved to.
      - `from` string, required: The first day of the window, `YYYY-MM-DD`.
      - `to` string, required: The last day of the window, `YYYY-MM-DD`.
    - `new_subscribers` integer, required: Subscriptions created inside the window.
    - `canceled_subscribers` integer, required: Subscriptions cancelled inside the window.
    - `active_at_window_start` integer, required: Subscriptions that were active on the window's first day: the base the churn rate is measured against.
    - `churn_rate_percent` number, required: `canceled_subscribers` as a percentage of `active_at_window_start`, two decimals; `0` when nobody was active.
    - `trial_started` integer, required: Trials that began inside the window.
    - `trial_converted` integer, required: Trials that became paying subscriptions inside the window.
    - `trial_to_paid_percent` number, required: `trial_converted` as a percentage of `trial_started`, two decimals; `0` when no trial began.
    - `status_distribution` object, required: How many subscriptions the scope holds in each payment status right now, keyed by status.
  - `meta` object, required: The request's window and scope, echoed back.
    - `period` string, required: The preset the window resolved from, as requested.
    - `project_id` string, nullable, required: The project the figures were scoped to, or `null` for every project the token may see.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `422`: `VALIDATION_FAILED`: when `project_id` is not a UUID.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)