Skip to main content

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/

Parameters

NameTypeRequiredDescription
chart_idString

define which char 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
filtersMetricsFilters objectAn object containing filtration parameters. See details below this table.
period_unitStringSpecify the time interval for aggregating analytics data, to view results grouped by selected periods, such as days, weeks, months, etc. Possible values are:
  • day
  • week
  • month
  • quarter
  • year
segmentationStringSets the basis for segmentation. See which segmentation is available for different chats in teh Segmentatiuon table below this table
formatStringSpecify the export file format. Available options are:
  • json
  • csv

Segmentation

Different charts can use different types of segmentation:

For ARPU (click to expand)
  • 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 (click to expand)
  • 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 ARRPU (click to expand)
  • 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 subscriptopns, new trials, and refund events (click to expand)
  • 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 (click to expand)
  • 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 subscriptipn renewals, cancelled trials, grace periods, billing issues, money refunds, and non-subscription purchases (click to expand)
  • 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 (click to expand)
  • country
  • store
  • attribution_status
  • attribution_channel
  • attribution_campaign
  • attribution_adgroup
  • attribution_adset
  • attribution_creative
  • attribution_source

MetricsFilters object

Filtration criteria differe for different chats. Please see below the variants:

For ARPU and installs (click to expand)
NameTypeRequiredDescription
datearray of String values(data)Enter the date or time period for which you want to retrieve chart data.
storearray of String valuesFilter 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.
countryarray of String valuesFilter by the 2-letter country code where the purchase took place, using ISO 3166-1 standard codes.
attribution_sourcearray of String valuesThe source integration for attribution. Possible options:
  • adjust
  • airbridge
  • apple_search_ads
  • appsflyer
  • branch
  • custom
attribution_statusarray of String valuesIndicates if the attribution is organic or non-organic. Possible values are:
  • organic
  • non-organic
  • unknown
attribution_channelarray of String valuesMarketing channel that led to the transaction.
attribution_campaignarray of String valuesMarketing campaign that brought the transaction.
attribution_adgrouparray of String valuesAttribution ad group that brought the transaction.
attribution_adsetarray of String valuesAttribution ad set that led to the transaction.
attribution_creativearray of String valuesSpecific visual or text elements in an ad or campaign tracked to measure effectiveness (e.g., clicks, conversions).
For cancelled trials, expired trials, grace period, billing issues, cancelled subscription renewals, expired subscriptions (click to expand)
NameTypeRequiredDescription
datearray of String values(data)Enter the date or period for which you want to retrieve chart data.
storearray of String valuesFilter 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.
countryarray of String valuesFilter by the 2-letter country code where the purchase took place, using ISO 3166-1 standard codes.
store_product_idarray of String valuesUnique identifier of a product from the app store. You can see this ID in the Products section of the Adapty Dashboard.
durationarray of StringSpecify the subscription duration. Possible values are:
  • Weekly
  • Monthly
  • 2 months
  • 3 months
  • 6 months
  • Annual
  • Lifetime
  • Uncategorized
attribution_sourcearray of String valuesThe source integration for attribution. Possible options:
  • adjust
  • airbridge
  • apple_search_ads
  • appsflyer
  • branch
  • custom
attribution_statusarray of String valuesIndicates if the attribution is organic or non-organic. Possible values are:
  • organic
  • non-organic
  • unknown
attribution_channelarray of String valuesMarketing channel that led to the transaction.
attribution_campaignarray of String valuesMarketing campaign that brought the transaction.
attribution_adgrouparray of String valuesAttribution ad group that brought the transaction.
attribution_adsetarray of String valuesAttribution ad set that led to the transaction.
attribution_creativearray of String valuesSpecific visual or text elements in an ad or campaign tracked to measure effectiveness (e.g., clicks, conversions).
For all other charts (click to expand)
NameTypeRequiredDescription
datearray of String values(data)Enter the date or period for which you want to retrieve chart data.
compare_datearray of String values(data)If comparing two dates or periods, enter the earlier one here and the later one in the date parameter.
storearray of String valuesFilter 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.
countryarray of String valuesFilter by the 2-letter country code where the purchase took place, using ISO 3166-1 standard codes.
store_product_idarray of String valuesUnique identifier of a product from the app store. You can see this ID in the Products section of the Adapty Dashboard.
durationarray of StringSpecify the subscription duration. Possible values are:
  • Weekly
  • Monthly
  • 2 months
  • 3 months
  • 6 months
  • Annual
  • Lifetime
  • Uncategorized
attribution_sourcearray of String valuesThe source integration for attribution. Possible options:
  • adjust
  • airbridge
  • apple_search_ads
  • appsflyer
  • branch
  • custom
attribution_statusarray of String valuesIndicates if the attribution is organic or non-organic. Possible values are:
  • organic
  • non-organic
  • unknown
attribution_channelarray of String valuesMarketing channel that led to the transaction.
attribution_campaignarray of String valuesMarketing campaign that brought the transaction.
attribution_adgrouparray of String valuesAttribution ad group that brought the transaction.
attribution_adsetarray of String valuesAttribution ad set that led to the transaction.
attribution_creativearray of String valuesSpecific visual or text elements in an ad or campaign tracked to measure effectiveness (e.g., clicks, conversions).
offer_categoryarray of String valuesSpecify the offer categories you want to retrieve data for. Possible values are:
  • introductory
  • promotional
  • winback
offer_typearray of String valuesSpecify the offer types you want to retrieve data for. Possible values are:
  • free_trial
  • pay_as_you_go
  • pay_up_front
.
offer_idarray of String valuesSpecify the specific offers you want to retrieve data for.

Request example

Example request (click to expand)

Below is an example request for measuring the impact of last year's marketing campaigns in the USA to see which ones brought in the highest revenue, with weekly tracking.

{
"filters": {
"date": [
"2022-01-01",
"2022-12-31"
],
"country": [
"us"
],
"attribution_channel": [
"social_media_influencers"
],
"period_unit": "week",
"segmentation": "attribution_campaign"
}