POST /api/v1/client-api/metrics/retention/

Retrieve retention data

Copy as Markdown

Retrieves the retention data to analyze the ability of a product to keep users engaged over time.

Rate limit: 2 requests per second.

Request body

filtersobjectrequired
datearray of stringrequired

Enter the date or time period for which you want to retrieve chart data

compare_datearray of string

Enter the comparison date or time period

storearray of string

Filter by the app store where the purchase was made

countryarray of string

Filter by the 2-letter country code where the purchase took place

store_product_idarray of string

Unique identifier of a product from the app store

durationarray of string

Specify the subscription duration

attribution_sourcearray of string

The source integration for attribution

attribution_statusarray of string

Indicates if the attribution is organic or non-organic

attribution_channelarray of string

Marketing channel that led to the transaction

attribution_campaignarray of string

Marketing campaign that brought the transaction

attribution_adgrouparray of string

Attribution ad group that brought the transaction

attribution_adsetarray of string

Attribution ad set that led to the transaction

attribution_creativearray of string

Specific visual or text elements in an ad or campaign tracked to measure effectiveness

offer_categoryarray of string

Specify the offer categories you want to retrieve data for

offer_typearray of string

Specify the offer types you want to retrieve data for

offer_idarray of string

Specify the specific offers you want to retrieve data for

period_unitstring

Specify the time interval for aggregating analytics data

One of: "day", "week", "month", "quarter", "year"

segmentationstring

Sets the basis for segmentation

use_trialboolean

Boolean indicating whether a trial was used

formatstring

Specify the export file format

One of: "json", "csv"

Responses

Retention data retrieved successfully

Schema

Response containing retention data showing user engagement over time

dataarray of object

Array of retention data points (can be empty for some retention types)

titlestring

Display title for the retention metric

metric_namestring

Internal name of the retention metric

descriptionstring

Explanation of how retention is calculated (absolute vs relative values)

value_typestring

Type of retention value (absolute or relative)

Example 
{
  "data": [],
  "title": "Subscription retention",
  "metric_name": "Subscription retention",
  "description": "Absolute value is the amount of users who entered the current step - subscribed for a trial or paid for a subscription. Relative is calculated as a percentage of these users among those who got a trial. So it starts with 100% for the trial step.",
  "value_type": null
}

Bad Request

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Unauthorized

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Rate limit exceeded. Maximum 2 requests per second per API key.