Analytics

Earnings report

The full earnings breakdown (gross, fees, net, transaction count) plus a timeseries bucketed by granularity: day (the default), week or month.

curl "https://api.subscriby.net/v1/analytics/earnings?granularity=week" \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Every money figure is USD-normalised so buckets in different currencies add up; totals.currency says so.

get/v1/analytics/earnings

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/analytics/earnings
  • 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.

granularitystring

The bucket size of the timeseries: day (the default), week or month. Anything else is 422 VALIDATION_FAILED.

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

Gross, fees and net per bucket.

Changes

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