Retrieve analytics data

Retrieves analytics data for insights on user behavior and performance metrics to further use in charts.

Endpoint and method

POST https://api-admin.adapty.io/api/v1/client-api/metrics/analytics/

Request example

cURL
Python
JavaScript

curl --location 'https://api-admin.adapty.io/api/v1/client-api/metrics/analytics/' \
--header 'Authorization: Api-Key <YOUR_SECRET_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "chart_id": "revenue",
  "filters": {
    "date": [
      "2024-01-01",
      "2024-12-31"
    ],
    "country": [
      "us"
    ],
    "attribution_channel": [
      "social_media_influencers"
    ]
  },
  "period_unit": "week",
  "segmentation": "attribution_campaign"
}'

import requests
import json

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

payload = json.dumps({
"chart_id": "revenue",
"filters": {
  "date": [
    "2024-01-01",
    "2024-12-31"
  ],
  "country": [
    "us"
  ],
  "attribution_channel": [
    "social_media_influencers"
  ]
},
"period_unit": "week",
"segmentation": "attribution_campaign"
})
headers = 
'Authorization': "Api-Key <YOUR_SECRET_API_KEY>",
'Content-Type': "application/json"}

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

print(response.text)

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

const raw = JSON.stringify({
"chart_id": "revenue",
"filters": {
  "date": [
    "2024-01-01",
    "2024-12-31"
  ],
  "country": [
    "us"
  ],
  "attribution_channel": [
    "social_media_influencers"
  ]
},
"period_unit": "week",
"segmentation": "attribution_campaign"
});

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

fetch("https://api-admin.adapty.io/api/v1/client-api/metrics/analytics/", 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 filter parameters. See details below this table.
chart_id	String	➖	Specify which chart you need. Possible values are: revenue mrr arr arppu subscriptions_active subscriptions_new subscriptions_renewal_cancelled subscriptions_expired trials_active trials_new trials_renewal_cancelled trials_expired grace_period billing_issue refund_events refund_money non_subscriptions arpu installs
period_unit	String	➖	Specify the time interval for aggregating analytics data, so you can view results grouped by days, weeks, months, etc. Possible values are: day week month (default) quarter year
date_type	String	➖	Possible values are: purchase_date (default) profile_install_date
segmentation	String	➖	Sets the basis for segmentation. See which segmentation is available for different charts in the Segmentation table below.
format	String	➖	Specify the export file format. Available options are: json (default) csv

Segmentation

Different charts can use different types of segmentation:

For ARPU

country
store
attribution_status
attribution_channel
attribution_campaign
attribution_adgroup
attribution_adset
attribution_creative
attribution_source
period

For revenue, MRR, ARR, active subscriptions, and active trials

country
store
attribution_status
attribution_channel
attribution_campaign
attribution_adgroup
attribution_adset
attribution_creative
attribution_source
store_product_id
paywall_id
audience_id
placement_id
duration
renewal_status
period
offer_category
offer_type
offer_id

For ARPPU

country
store
attribution_status
attribution_channel
attribution_campaign
attribution_adgroup
attribution_adset
attribution_creative
attribution_source
store_product_id
paywall_id
audience_id
placement_id
duration
renewal_status
period

For new subscriptions, new trials, and refund events

country
store
attribution_status
attribution_channel
attribution_campaign
attribution_adgroup
attribution_adset
attribution_creative
attribution_source
store_product_id
paywall_id
audience_id
placement_id
duration
offer_category
offer_type
offer_id

For expired subscriptions and expired trials

country
store
attribution_status
attribution_channel
attribution_campaign
attribution_adgroup
attribution_adset
attribution_creative
attribution_source
store_product_id
paywall_id
audience_id
placement_id
duration
cancellation_reason

For cancelled subscription renewals, cancelled trials, grace periods, billing issues, money refunds, and non-subscription purchases

country
store
attribution_status
attribution_channel
attribution_campaign
attribution_adgroup
attribution_adset
attribution_creative
attribution_source
store_product_id
paywall_id
audience_id
placement_id
duration

For installs

country
store
attribution_status
attribution_channel
attribution_campaign
attribution_adgroup
attribution_adset
attribution_creative
attribution_source

MetricsFilters object

Filtration criteria differ for different charts. See the variants below:

For ARPU and installs

Name	Type	Required	Description.
date	array of String values	➕	Enter the date or time 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 you use 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.
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: 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).

For cancelled trials, expired trials, grace periods, billing issues, cancelled subscription renewals, and expired subscriptions

Name	Type	Required	Description.
date	array of String values	➕	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 you use 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 find this ID in the Products section of the Adapty Dashboard.
duration	array of String	➖	Specify the subscription duration. Possible values: 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: 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).

For all other charts

Name	Type	Required	Description
date	array of String values(data)	➕	Enter the date or period for which you want to retrieve chart data.
compare_date	array of String values(data)	➖	If comparing two dates or periods, enter the earlier one here and the later one in the `date` parameter.
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.

Endpoint and method​

Request example​

Parameters​

Segmentation​

For ARPU​

For revenue, MRR, ARR, active subscriptions, and active trials​

For ARPPU​

For new subscriptions, new trials, and refund events​

For expired subscriptions and expired trials​

For cancelled subscription renewals, cancelled trials, grace periods, billing issues, money refunds, and non-subscription purchases​

For installs​

MetricsFilters object​

For ARPU and installs​

For cancelled trials, expired trials, grace periods, billing issues, cancelled subscription renewals, and expired subscriptions​

For all other charts​