# Retrieve a subscription cancellation report

Retrieves a subscription cancellation report.

Endpoint: GET /experimental/reports/subscription-cancellation
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `periodStart` (string, required)
    Date and time when the report starts.

  - `periodEnd` (string, required)
    Date and time when the report ends.

  - `aggregationField` (string, required)
    Report aggregation field.
    Enum: "planId", "websiteId", "canceledBy", "cancelCategory", "leadSource.source", "leadSource.medium", "leadSource.campaign", "leadSource.content", "leadSource.term", "leadSource.affiliate", "leadSource.subAffiliate", "leadSource.salesAgent"

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    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.

## Response 200 fields (application/json):

  - `data` (array)
    Subscription cancellation data.

  - `data.aggregationValue` (string)
    Aggregation value.

  - `data.count` (integer)
    Total number of canceled subscriptions.

  - `data.averageLength` (number)
    Average length of canceled subscription from start to end within the aggregation in seconds.

  - `data.medianLength` (number)
    Median length of canceled subscription from start to end within the aggregation in seconds.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.