POST
/api/v1/client-api/metrics/retention/ 获取留存数据
获取留存数据，用于分析产品在一段时间内留住用户的能力。
速率限制：每秒 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 或带有基础计划的 Google 订阅 play_store:premium_sub:monthly-base-plan。不带商店前缀的纯产品 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
指定您想要检索数据的具体优惠
period_unitstring
指定用于聚合分析数据的时间间隔
One of: "day", "week", "month", "quarter", "year"
segmentationstring
设置市场细分的依据
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
超出速率限制。每个 API 密钥每秒最多 2 次请求。