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

获取留存数据

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

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"

use_trialboolean

布尔值，指示是否使用了试用

formatstring

指定导出文件格式

One of: "json", "csv"

Responses

留存数据获取成功

Schema

包含用户随时间变化的留存数据的响应

dataarray of object

留存数据点数组（某些留存类型可能为空）

titlestring

留存数据图表的显示标题

metric_namestring

留存数据图表的内部名称

descriptionstring

留存计算方式的说明（绝对值与相对值）

value_typestring

留存值的类型（绝对值或相对值）

Example 
{
  "data": [],
  "title": "Subscription retention",
  "metric_name": "Subscription retention",
  "description": "Absolute value is the amount of users who entered the current step - subscribed for a trial or paid for a subscription. Relative is calculated as a percentage of these users among those who got a trial. So it starts with 100% for the trial step.",
  "value_type": null
}

请求无效

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 密钥共享。