# Retrieve a cumulative subscriptions report

Retrieves a cumulative subscriptions report.

Endpoint: GET /experimental/reports/cumulative-subscriptions
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `aggregationField` (string, required)
    Report aggregation field.
    Enum: "day", "month", "affiliate_month"

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

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

  - `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)
    Cumulative subscription data.

  - `data.aggregationValue` (string)
    Date in  format for monthly aggregation, or  for daily aggregation.

  - `data.newCount` (integer)
    Number of new subscriptions within the aggregation.

  - `data.canceledCount` (integer)
    Number of canceled subscriptions within the aggregation.

  - `data.cumulativeCount` (integer)
    Total number of cumulative subscriptions.

This field is calculated based on: the number of cumulative subscriptions from the previous aggregation period +  - .

## 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.