English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/client-api/metrics/funnel/

Retrieve funnel data

Copy as Markdown

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

Rate limit: 2 requests per second.

Request body

filtersobjectrequired
datearray of stringrequired

Enter the date or time period for which you want to retrieve chart data

compare_datearray of string

Enter the comparison date or time period

storearray of string

Filter by the app store where the purchase was made

countryarray of string

Filter by the 2-letter country code where the purchase took place

store_product_idarray of string

Store-qualified product ID, formatted as <store>:<product_id> — for example app_store:premium_monthly or play_store:premium_sub:monthly-base-plan for a Google subscription with a base plan. A bare product ID with no store prefix is rejected.

durationarray of string

Specify the subscription duration

attribution_sourcearray of string

The source integration for attribution

attribution_statusarray of string

Indicates if the attribution is organic or non-organic

attribution_channelarray of string

Marketing channel that led to the transaction

attribution_campaignarray of string

Marketing campaign that brought the transaction

attribution_adgrouparray of string

Attribution ad group that brought the transaction

attribution_adsetarray of string

Attribution ad set that led to the transaction

attribution_creativearray of string

Specific visual or text elements in an ad or campaign tracked to measure effectiveness

offer_categoryarray of string

Specify the offer categories you want to retrieve data for

offer_typearray of string

Specify the offer types you want to retrieve data for

offer_idarray of string

Specify the specific offers you want to retrieve data for

placement_idarray of string

Adapty's internal IDs of the placements to retrieve data for — the UUID in the placement's dashboard URL, not the placement ID you pass to the SDK

audience_idarray of string

Adapty's internal IDs of the placement audiences to retrieve data for

paywall_idarray of string

Adapty's internal IDs of the paywalls to retrieve data for — the UUID in the paywall's dashboard URL

flow_idarray of string

Adapty's internal IDs of the flows to retrieve data for — the UUID in the flow's dashboard URL

flow_screen_idarray of string

Flow screens to retrieve data for, each formatted as <flow_id>:<screen_id> — for example 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

Adapty's internal IDs of the segments to retrieve data for

show_value_asstring

Specify how values are displayed

One of: "absolute", "relative", "both"

segmentationstring

Splits the data into one series per value of this dimension. For example, flow_id returns a separate series for each flow, and placement_id for each placement.

One of: "period", "renewal_status", "cancellation_reason", "store_product_id", "country", "store", "paywall_id", "audience_id", "placement_id", "flow_id", "flow_screen_id", "segment_id", "duration", "offer_category", "offer_type", "offer_id", "attribution_source", "attribution_status", "attribution_channel", "attribution_campaign", "attribution_adgroup", "attribution_adset", "attribution_creative", "day", "week", "month", "year"

formatstring

Specify the export file format

One of: "json", "csv"

Responses

Funnel data retrieved successfully

Schema

Response containing funnel analysis data showing user progression through conversion stages

dataarray of object

Array of funnel segments showing different stages of the conversion process

titlestring

Display title for this funnel segment

typestring

Type of funnel segment ('total' for aggregated data)

valuesarray of object

Array of funnel values showing progression through stages

periodinteger

Period number in the funnel (-2 = Install, -1 = Paywall displayed, etc.)

titlestring

Display title for this funnel stage

valueinteger

Number of users who reached this stage

value_relativenumber

Percentage of users who reached this stage relative to the first stage

relative_changesnumber

Change in conversion rate compared to previous period

following_changesobject

Information about users who dropped off after this stage

titlestring

Title for the drop-off stage

valueinteger

Number of users who dropped off

value_relativenumber

Percentage of users who dropped off

churn_reason_titlestring

Title describing the reason for churn at this stage

churn_reasonsarray of object

Array of specific churn reasons

valuesarray of object

Additional nested values for this funnel stage

Example 
{
  "data": [
    {
      "title": "Total",
      "type": "total",
      "values": [
        {
          "period": -2,
          "title": "Install",
          "value": 2,
          "value_relative": 100,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 2,
            "value_relative": 100
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        },
        {
          "period": -1,
          "title": "Paywall displayed",
          "value": 0,
          "value_relative": 0,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 0,
            "value_relative": 0
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        }
      ]
    }
  ]
}

Bad Request

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Unauthorized

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Rate limit exceeded. Maximum 2 requests per second per app, shared by all of the app's API keys.