Retrieve cohort data
Retrieve cohort data to track user groups over time.
Endpoint and method
POST https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/
Request example
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | MetricsFilters object | :heavy_plus_sign: | An object containing filtration parameters. See details below this table. |
| period_unit | String | :heavy_minus_sign: | Specify the time interval for aggregating analytics data to view results grouped by selected periods (days, weeks, months, etc.). Possible values are:
|
| period_type | String | :heavy_minus_sign: | Analyze data by renewals or by days. For a detailed description, see Tracking by renewals or by days. Possible values are:
|
| value_type | String | :heavy_minus_sign: | Specify how values are displayed. Possible values are:
|
| value_field | String | :heavy_minus_sign: | Specify the type of values displayed. Possible values are:
|
| accounting_type | String | :heavy_minus_sign: | The accounting method used. Possible values are:
|
| renewal_days | Array of Integers | :heavy_minus_sign: | This is a list of days since the app was installed for the cohort type period_type=days. Default: 0, 3, 7, 14, 28, 31, 61, 92, 183, 336, 550, 731. |
| prediction_months | Integer | :heavy_minus_sign: | Enter how many months of prediction you want. Possible values: 3, 6, 9, 12 (default), 18, 24. |
| format | String | :heavy_minus_sign: | Specify the export file format. Available options are:
|
MetricsFilters object
| Name | Type | Required | Description |
|---|---|---|---|
| date | array of String values(data) | :heavy_plus_sign: | Enter the date or period for which you want to retrieve chart data. |
| store | array of String values | :heavy_minus_sign: | Filter by the app store where the purchase was made. Possible values include app_store, play_store, stripe, and any custom store ID. If using a custom store, enter its ID as set in the Adapty Dashboard. |
| country | array of String values | :heavy_minus_sign: | Filter by the 2-letter country code where the purchase took place, using ISO 3166-1 standard codes. |
| store_product_id | array of String values | :heavy_minus_sign: | Unique identifier of a product from the app store. You can see this ID in the Products section of the Adapty Dashboard. |
| duration | array of String | :heavy_minus_sign: | Specify the subscription duration. Possible values are:
|
| attribution_source | array of String values | :heavy_minus_sign: | The source integration for attribution. Possible options:
|
| attribution_status | array of String values | :heavy_minus_sign: | Indicates if the attribution is organic or non-organic. Possible values are:
|
| attribution_channel | array of String values | :heavy_minus_sign: | Marketing channel that led to the transaction. |
| attribution_campaign | array of String values | :heavy_minus_sign: | Marketing campaign that brought the transaction. |
| attribution_adgroup | array of String values | :heavy_minus_sign: | Attribution ad group that brought the transaction. |
| attribution_adset | array of String values | :heavy_minus_sign: | Attribution ad set that led to the transaction. |
| attribution_creative | array of String values | :heavy_minus_sign: | Specific visual or text elements in an ad or campaign tracked to measure effectiveness (e.g., clicks, conversions). |
| offer_category | array of String values | :heavy_minus_sign: | Specify the offer categories you want to retrieve data for. Possible values are:
|
| offer_type | array of String values | :heavy_minus_sign: | Specify the offer types you want to retrieve data for. Possible values are:
|
| offer_id | array of String values | :heavy_minus_sign: | Specify the specific offers you want to retrieve data for. |