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

cURL

curl --location 'https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/' \
--header 'Authorization: Api-Key <YOUR_SECRET_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "filters": {
    "date": [
      "2024-04-01",
      "2024-09-30"
    ],
    "store": [
      "app_store"
    ],
    "country": [
      "us"
    ]
  },
  "period_unit": "month",
  "period_type": "renewals",
  "value_type": "absolute",
  "value_field": "subscriptions"
}'

Python

import requests
import json

url = "https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/"

payload = json.dumps({
"filters": {
  "date": [
    "2024-04-01",
    "2024-09-30"
  ],
  "store": [
    "app_store"
  ],
  "country": [
    "us"
  ]
},
"period_unit": "month",
"period_type": "renewals",
"value_type": "absolute",
"value_field": "subscriptions"
})
headers = {
'Authorization': "Api-Key <YOUR_SECRET_API_KEY>",
'Content-Type': "application/json"
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JavaScript

const myHeaders = new Headers();
myHeaders.append("Authorization", "Api-Key <YOUR_SECRET_API_KEY>");
myHeaders.append("Content-Type", "application/json");

const raw = JSON.stringify({
"filters": {
  "date": [
    "2024-04-01",
    "2024-09-30"
  ],
  "store": [
    "app_store"
  ],
  "country": [
    "us"
  ]
},
"period_unit": "month",
"period_type": "renewals",
"value_type": "absolute",
"value_field": "subscriptions"
});

const requestOptions = {
method: "POST",
headers: myHeaders,
body: raw,
redirect: "follow"
};

fetch("https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));

Parameters

Name	Type	Required	Description
filters	MetricsFilters object	➕	An object containing filtration parameters. See details below this table.
period_unit	String	➖	Specify the time interval for aggregating analytics data to view results grouped by selected periods (days, weeks, months, etc.). Possible values are: day week month (default) quarter year
period_type	String	➖	Analyze data by renewals or by days. For a detailed description, see Tracking by renewals or by days. Possible values are: listitem listitem listitem renewals (default).days.
value_type	String	➖	Specify how values are displayed. Possible values are: absolute (default): as a percentage of the total relative: as a percentage from the start, starting at 100% for renewal periods
value_field	String	➖	Specify the type of values displayed. Possible values are: revenue (default) arppu arpu arpas subscribers subscriptions
accounting_type	String	➖	The accounting method used. Possible values are: revenue (default) proceeds net_revenue
renewal_days	Array of Integers	➖	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	➖	Enter how many months of prediction you want. Possible values: 3, 6, 9, 12 (default), 18, 24.
format	String	➖	Specify the export file format. Available options are: json (default) csv

MetricsFilters object

Name	Type	Required	Description
date	array of String values(data)	➕	Enter the date or period for which you want to retrieve chart data.
store	array of String values	➖	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	➖	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	➖	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	➖	Specify the subscription duration. Possible values are: Weekly Monthly 2 months 3 months 6 months Annual Lifetime Uncategorized
attribution_source	array of String values	➖	The source integration for attribution. Possible options: adjust airbridge apple_search_ads appsflyer branch custom
attribution_status	array of String values	➖	Indicates if the attribution is organic or non-organic. Possible values are: organic non-organic unknown
attribution_channel	array of String values	➖	Marketing channel that led to the transaction.
attribution_campaign	array of String values	➖	Marketing campaign that brought the transaction.
attribution_adgroup	array of String values	➖	Attribution ad group that brought the transaction.
attribution_adset	array of String values	➖	Attribution ad set that led to the transaction.
attribution_creative	array of String values	➖	Specific visual or text elements in an ad or campaign tracked to measure effectiveness (e.g., clicks, conversions).
offer_category	array of String values	➖	Specify the offer categories you want to retrieve data for. Possible values are: introductory promotional winback
offer_type	array of String values	➖	Specify the offer types you want to retrieve data for. Possible values are: free_trial pay_as_you_go pay_up_front
offer_id	array of String values	➖	Specify the specific offers you want to retrieve data for.