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

获取漏斗数据

Copy as Markdown

获取漏斗数据，用于跟踪用户在转化流程特定阶段的进展情况。

频率限制：每秒 2 次请求。

Request body

filtersobjectrequired
datearray of stringrequired

输入您希望检索数据图表数据的日期或时间段

compare_datearray of string

输入用于对比的日期或时间段

storearray of string

按购买所在的应用商店筛选

countryarray of string

按购买发生地的两字母国家代码筛选

store_product_idarray of string

带商店前缀的产品 ID，格式为 <store>:<product_id>，例如 app_store:premium_monthly 或 play_store:premium_sub:monthly-base-plan（含基础方案的 Google 订阅）。不带商店前缀的纯产品 ID 将被拒绝。

durationarray of string

指定订阅时长

attribution_sourcearray of string

归因的来源集成

attribution_statusarray of string

指示归因是自然流量还是非自然流量

attribution_channelarray of string

带来该交易的营销渠道

attribution_campaignarray of string

带来该交易的营销活动

attribution_adgrouparray of string

带来该交易的归因广告组

attribution_adsetarray of string

带来该交易的归因广告集

attribution_creativearray of string

广告或营销活动中用于衡量效果的具体视觉或文字素材

offer_categoryarray of string

指定您希望检索数据的优惠类别

offer_typearray of string

指定您希望检索数据的优惠类型

offer_idarray of string

指定您希望检索数据的具体优惠

placement_idarray of string

用于检索数据的版位在 Adapty 内部的 ID——即版位在 Adapty 看板 URL 中的 UUID，而非传递给 SDK 的版位 ID

audience_idarray of string

用于检索数据的版位目标受众在 Adapty 内部的 ID

paywall_idarray of string

用于检索数据的付费墙在 Adapty 内部的 ID——即付费墙在 Adapty 看板 URL 中的 UUID

flow_idarray of string

用于检索数据的流程在 Adapty 内部的 ID——即流程在 Adapty 看板 URL 中的 UUID

flow_screen_idarray of string

用于检索数据的流程屏幕，每项格式为 <flow_id>:<screen_id>，例如 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

用于检索数据的市场细分在 Adapty 内部的 ID

show_value_asstring

指定值的显示方式

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

segmentationstring

按此维度的每个值将数据拆分为独立的数据系列。例如，flow_id 为每个流程返回单独的数据系列，placement_id 为每个版位返回单独的数据系列。

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

指定导出文件格式

One of: "json", "csv"

Responses

漏斗数据获取成功

Schema

包含漏斗分析数据的响应，展示用户在转化阶段的进展情况

dataarray of object

漏斗市场细分数组，展示转化流程的不同阶段

titlestring

此漏斗细分的显示标题

typestring

漏斗细分的类型（'total' 表示汇总数据）

valuesarray of object

漏斗值数组，展示各阶段的转化进程

periodinteger

漏斗中的阶段编号（-2 = 安装，-1 = 付费墙已展示，以此类推）

titlestring

该漏斗阶段的显示标题

valueinteger

到达该阶段的用户数量

value_relativenumber

到达该阶段的用户占第一阶段用户的百分比

relative_changesnumber

与上一阶段相比的转化率变化

following_changesobject

在该阶段之后流失的用户信息

titlestring

流失阶段的标题

valueinteger

流失的用户数量

value_relativenumber

流失用户的百分比

churn_reason_titlestring

描述该阶段用户流失原因的标题

churn_reasonsarray of object

具体流失原因的数组

valuesarray of object

该漏斗阶段的额外嵌套数值

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": []
        }
      ]
    }
  ]
}

请求无效

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

未授权

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

超出频率限制。每个应用每秒最多 2 次请求，由该应用的所有 API 密钥共享。