POST /api/v1/client-api/metrics/cohort/

Retrieve cohort data

Copy as Markdown

Retrieve cohort data to track user groups 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"

period_typestring

Analyze data by renewals or by days

One of: "renewals", "days"

value_typestring

Specify how values are displayed

One of: "absolute", "relative"

value_fieldstring

Specify the type of values displayed

One of: "revenue", "arppu", "arpu", "arpas", "subscribers", "subscriptions"

accounting_typestring

The accounting method used

One of: "revenue", "proceeds", "net_revenue"

renewal_daysarray of integer

List of days since the app was installed for the cohort type period_type=days

prediction_monthsinteger

Enter how many months of prediction you want

One of: 3, 6, 9, 12, 18, 24

formatstring

Specify the export file format

One of: "json", "csv"

Responses

Cohort data retrieved successfully

Schema

Response containing cohort analysis data showing user behavior over time

dataarray of object

Array of cohort segments, each representing a group of users who started in the same period

segment_start_datestring

The start date of this cohort segment

typestring

Type of segment ('total' for aggregated data, 'single' for individual cohort)

titlestring

Display title for this cohort segment

total_installsinteger

Total number of app installs in this cohort

total_subscriptionsinteger

Total number of subscriptions in this cohort

total_paid_subscribersinteger

Total number of paid subscribers in this cohort

total_revenue_usdnumber

Total revenue in USD for this cohort

total_proceeds_usdnumber

Total proceeds in USD for this cohort (after store fees)

total_net_revenue_usdnumber

Total net revenue in USD for this cohort

total_anrpas_usdnumber

Total Average Revenue Per Active Subscriber (ANRPAS) in USD

total_appas_usdnumber

Total Average Proceeds Per Active Subscriber (APPAS) in USD

total_arpas_usdnumber

Total Average Revenue Per Active Subscriber (ARPAS) in USD

total_anrppu_usdnumber

Total Average Revenue Per Paying User (ANRPPU) in USD

total_apppu_usdnumber

Total Average Proceeds Per Paying User (APPPU) in USD

total_arppu_usdnumber

Total Average Revenue Per Paying User (ARPPU) in USD

total_anrpu_usdnumber

Total Average Revenue Per User (ANRPU) in USD

total_appu_usdnumber

Total Average Proceeds Per User (APPU) in USD

total_arpu_usdnumber

Total Average Revenue Per User (ARPU) in USD

predictobject

Prediction data for this cohort (if available)

valuesarray of object

Array of period-based values showing cohort performance over time

arpas_usdnumber

Average Revenue Per Active Subscriber in USD for this period

appas_usdnumber

Average Proceeds Per Active Subscriber in USD for this period

anrpas_usdnumber

Average Net Revenue Per Active Subscriber in USD for this period

anrppu_usdnumber

Average Net Revenue Per Paying User in USD for this period

apppu_usdnumber

Average Proceeds Per Paying User in USD for this period

arppu_usdnumber

Average Revenue Per Paying User in USD for this period

anrpu_usdnumber

Average Net Revenue Per User in USD for this period

appu_usdnumber

Average Proceeds Per User in USD for this period

arpu_usdnumber

Average Revenue Per User in USD for this period

installsinteger

Number of app installs in this period

periodinteger

Period number (1 = first period, 2 = second period, etc.)

revenue_usdnumber

Total revenue in USD for this period

proceeds_usdnumber

Total proceeds in USD for this period (after store fees)

net_revenue_usdnumber

Total net revenue in USD for this period

revenue_relativenumber

Revenue as percentage relative to the first period (100% = first period)

proceeds_relativenumber

Proceeds as percentage relative to the first period (100% = first period)

net_revenue_relativenumber

Net revenue as percentage relative to the first period (100% = first period)

subscriptionsinteger

Number of subscriptions in this period

subscriptions_relativenumber

Subscriptions as percentage relative to the first period (100% = first period)

subscribersinteger

Number of subscribers in this period

subscribers_relativenumber

Subscribers as percentage relative to the first period (100% = first period)

currently_active_periodboolean

Whether this is the currently active period for the cohort

Example

{
  "data": [
    {
      "segment_start_date": "2024-04-01",
      "type": "total",
      "title": "Total",
      "total_installs": 0,
      "total_subscriptions": 0,
      "total_paid_subscribers": 0,
      "total_revenue_usd": 0,
      "total_proceeds_usd": 0,
      "total_net_revenue_usd": 0,
      "total_anrpas_usd": 0,
      "total_appas_usd": 0,
      "total_arpas_usd": 0,
      "total_anrppu_usd": 0,
      "total_apppu_usd": 0,
      "total_arppu_usd": 0,
      "total_anrpu_usd": 0,
      "total_appu_usd": 0,
      "total_arpu_usd": 0,
      "predict": null,
      "values": [
        {
          "arpas_usd": 0,
          "appas_usd": 0,
          "anrpas_usd": 0,
          "anrppu_usd": 0,
          "apppu_usd": 0,
          "arppu_usd": 0,
          "anrpu_usd": 0,
          "appu_usd": 0,
          "arpu_usd": 0,
          "installs": 0,
          "period": 1,
          "revenue_usd": 0,
          "proceeds_usd": 0,
          "net_revenue_usd": 0,
          "revenue_relative": 0,
          "proceeds_relative": 0,
          "net_revenue_relative": 0,
          "subscriptions": 0,
          "subscriptions_relative": 0,
          "subscribers": 0,
          "subscribers_relative": 0,
          "currently_active_period": false
        }
      ]
    }
  ]
}

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.

Try it

Authorization

Body

curl --request POST \
  --url '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"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: 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 data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "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"
    })
data = response.json()