---
title: "Headline figures"
method: GET
path: "/v1/analytics/dashboard"
tags: ["Analytics"]
---

# Headline figures

`GET /v1/analytics/dashboard`

## Request

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

Total revenue, total transactions, total users and MRR, each with a trend relative to the `compare_period` window and a sparkline. The **Recurring Monthly Income** tile counts only active subscriptions on recurring plans, normalised to a monthly figure; one-time and lifetime plans are excluded.

```bash
curl "https://api.subscriby.net/v1/analytics/dashboard?period=30d&compare_period=previous" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
```

## Query parameters

- `project_id` string, uuid
- `period` string
- `from` string, date
- `to` string, date
- `compare_period` string
- `plan_ids[]` string[]
- `statuses[]` string[]
- `payment_method_ids[]` string[]

## Response `200`

The headline tiles.

- object
  - `data` object[], required: The items.
    - `title` string, required: The tile's name, in the creator's language.
    - `value` string, required: The formatted figure, USD-normalised for money.
    - `trend` string, required: The change against the comparison window as a percentage; absent when `compare_period` is `none`.
    - `trendUp` boolean, required: Whether the figure rose against the comparison window.
    - `charting` union[], required: The sparkline's points across the window, oldest first.
      - union
        - number
        - integer
  - `meta` object, required: The window the figures were computed for, echoed back.
    - `period` string, required: The preset the window resolved from, as requested.
    - `compare_period` string, required: `previous` or `none`, 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.
- `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)