Skip to main content

Retrieve funnel data

Retrieves funnel data to track user progression through specific stages of a conversion process.

Endpoint and method

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

Parameters

NameTypeRequiredDescription
filtersMetricsFiltersAn 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
show_value_asStringSpecify how values are displayed. Possible values are:
  • absolute: as a percentage of the total
  • relative: as a percentage from the start, starting at 100% for renewal periods.
  • both
segmentationStringSets the basis for segmentation. Possible values are:
  • app_id
  • period
  • renewal_status
  • cancellation_reason
  • store_product_id
  • country
  • store
  • purchase_container_id
  • paywall_id
  • audience_id
  • placement_id
  • attribution_source
  • attribution_status
  • attribution_channel
  • attribution_campaign
  • attribution_adgroup
  • attribution_adset
  • attribution_creative
  • duration
  • default
formatStringSpecify the export file format. Available options are:
  • json
  • csv

MetricsFilters object

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)

The example below shows how to monitor how quickly users are unsubscribing to uncover churn patterns or gauge the success of retention efforts, focusing on France and a specific product.

{
"filters": {
"date": [
"2022-01-01",
"2022-12-31"
],
"compare_date": [
"2023-01-01",
"2023-12-31"
],
"country": [
"fr"
],
"store_product_id": [
[
"monthly.premium.599"
]
],
},
"period_unit": "month",
"segmentation": "renewal_status"
}