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
Name | Type | Required | Description |
---|---|---|---|
filters | MetricsFilters | ➕ | An object containing filtration parameters. See details below this table. |
period_unit | String | ➖ | Specify the time interval for aggregating analytics data, to view results grouped by selected periods, such as days, weeks, months, etc. Possible values are:
|
show_value_as | String | ➖ | Specify how values are displayed. Possible values are:
|
segmentation | String | ➖ | Sets the basis for segmentation. Possible values are:
|
format | String | ➖ | Specify the export file format. Available options are:
|
MetricsFilters object
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:
|
attribution_source | array of String values | ➖ | The source integration for attribution. Possible options:
|
attribution_status | array of String values | ➖ | Indicates if the attribution is organic or non-organic. Possible values are:
|
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:
|
offer_type | array of String values | ➖ | Specify the offer types you want to retrieve data for. Possible values are:
|
offer_id | array of String values | ➖ | Specify 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"
}