# Retrieve a retention value report

Retrieves the total number of new customers for each aggregation period and the corresponding value for each customer over time.

Endpoint: GET /experimental/reports/retention-value
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `aggregationField` (string, required)
    Report aggregation field.
    Enum: "day", "month", "quarter", "year", "leadsSource", "leadsMedium", "leadsCampaign", "leadsContent", "leadsTerm", "leadsAffiliate", "leadsSubAffiliate", "leadsSalesAgent", "bin"

  - `aggregationPeriod` (string, required)
    Report aggregation period.
    Enum: "day", "month", "quarter", "year"

  - `includeRefunds` (string)
    Specifies whether to include refunds.
    Enum: "true", "false"

  - `includeDisputes` (string)
    Specifies whether to include disputes.
    Enum: "true", "false"

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

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

  - `criteria` (string)
    Criteria parameter for requesting a collection.

## Response 200 fields (application/json):

  - `data` (array)
    Retention value data.

  - `data.aggregationValue` (string)
    Value by which the report provides retention periods and values.
Date values are displayed as follows:

- Day: .
- Month: .
- Quarter: /.
- Year: .

  - `data.customersCount` (integer)
    Number of customers within the aggregation who make their first payment.

  - `data.periods` (array)
    Periods of the specified aggregation.

  - `data.periods.period` (integer)
    Retention period number.
This value is measured from the beginning boundary of the aggregation.
  - : First period.
  - : Second period.
  - : Third period, and so on.

  - `data.periods.retentionAverage` (number)
    Summary amount of all transactions for all periods up to the current period divided by the aggregation customer number.

  - `data.periods.transactionsCount` (integer)
    Number of transactions that occurred within the retention period.
For example, in 3 rebills.

  - `data.periods.transactionsValue` (number)
    Total value of transactions.
This value is calculated based on:  minus .

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