Analytics

Headline figures

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.

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

Request

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

Query parameters

project_idstring uuid

Scope the figures to one project the token may see; omit for every project visible to it. A project outside the token's scope:project: allow-list is 404 TENANT_MISMATCH, an unknown one 404 RESOURCE_NOT_FOUND.

periodstring

The preset window: 7d, 14d, 30d (the default), 60d, 90d, mtd, qtd, ytd, 1y or all. Ignored when both from and to are given; an unknown value falls back to the default rather than failing.

fromstring date

The first day of an explicit window, YYYY-MM-DD. Both from and to are needed to override period.

tostring date

The last day of an explicit window, YYYY-MM-DD. Both from and to are needed to override period.

compare_periodstring

previous (the default) compares each tile with the window just before it and fills trend; none leaves the trend out.

plan_ids[]string[]

Count only these plans. Send it as plan_ids[]=a&plan_ids[]=b or as one comma-separated string.

statuses[]string[]

Count only payments in these states: successful, failed, pending, refunded. Send them as statuses[]=a&statuses[]=b or as one comma-separated string.

payment_method_ids[]string[]

Count only payments taken through these payment methods. Send them as payment_method_ids[]=a&payment_method_ids[]=b or as one comma-separated string.

Response

The headline tiles.

Example response

{
  "data": [
    {
      "title": "Total Revenue",
      "value": "$12,480.00",
      "trend": "12.4%",
      "trendUp": true
    }
  ],
  "meta": {
    "period": "30d",
    "compare_period": "previous"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.