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:
|
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:
|
date_type | String | ➖ | Possible values are:
|
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:
|
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