Retrieve a subscription cancellation report

Retrieves a subscription cancellation report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string <date-time>

Date and time when the report starts.

periodEnd
required
string <date-time>

Date and time when the report ends.

aggregationField
required
string

Report aggregation field.

Enum: "planId" "websiteId" "canceledBy" "cancelCategory" "leadSource.source" "leadSource.medium" "leadSource.campaign" "leadSource.content" "leadSource.term" "leadSource.affiliate" … 2 more
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array of objects

Subscription cancellation data.

Array
aggregationValue
string

Aggregation value.

count
integer

Total number of canceled subscriptions.

averageLength
number <double>

Average length of canceled subscription from start to end within the aggregation in seconds.

medianLength
number <double>

Median length of canceled subscription from start to end within the aggregation in seconds.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/subscription-cancellation
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.getSubscriptionCancellation(params);
Response samples
application/json
{
  • "data": [
    ]
}