logo

Retrieve a cumulative subscriptions report

Retrieve a cumulative subscriptions report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

Enum: "day" "month"
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

Responses
200

Report was retrieved successfully.

Response Schema: application/json
Array of objects
Array
aggregationValue
string

Date in format YYYY-MM (monthly aggregation) or YYYY-MM-DD (daily aggregation).

newCount
integer

Number of new subscriptions within the aggregation.

canceledCount
integer

Number of canceled subscriptions within the aggregation.

cumulativeCount
integer

Number of cumulative subscriptions from the previous aggregation + number of new subscriptions - number of canceled subscriptions within the aggregation.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/cumulative-subscriptions
Request samples
const params = {
    aggregationField: 'day',
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getCumulativeSubscriptions(params);
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Retrieve dashboard data