POST /api/v1/client-api/metrics/cohort/

获取同期群数据

获取同期群数据以追踪用户群组随时间的变化。

此端点的收入基于安装日期同期群：每位用户的收入归因于其安装日期，而非交易日期。响应中包含 total_revenue_usd 和 total_proceeds_usd。使用此端点（而非分析端点）可将内部报告与 Ads Manager 进行核对，因为 Ads Manager 同样基于同期群/安装日期。

速率限制：每秒 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

period_unitstring

指定聚合分析数据的时间间隔

One of: "day", "week", "month", "quarter", "year"

period_typestring

按续订次数或按天数分析数据

One of: "renewals", "days"

value_typestring

指定数值的显示方式

One of: "absolute", "relative"

value_fieldstring

指定所显示数值的类型

One of: "revenue", "arppu", "arpu", "arpas", "subscribers", "subscriptions"

accounting_typestring

所使用的核算方式

One of: "revenue", "proceeds", "net_revenue"

renewal_daysarray of integer

同期群类型 period_type=days 时，应用安装后的天数列表

prediction_monthsinteger

输入所需的趋势预测月数

One of: 3, 6, 9, 12, 18, 24

formatstring

指定导出文件格式

One of: "json", "csv"

Responses

同期群数据获取成功

Schema

包含同期群分析数据的响应，展示用户随时间变化的行为

dataarray of object

同期群细分数组，每个细分代表在同一时期开始的一组用户

segment_start_datestring

该同期群市场细分的开始日期

typestring

市场细分类型（'total' 表示汇总数据，'single' 表示单个同期群）

titlestring

该同期群市场细分的显示标题

total_installsinteger

该同期群的应用总安装量

total_subscriptionsinteger

该同期群的订阅总数

total_paid_subscribersinteger

该同期群的付费订阅者总数

total_revenue_usdnumber

该同期群的总收入（美元）

total_proceeds_usdnumber

该同期群的总收益（美元，扣除应用商店费用后）

total_net_revenue_usdnumber

该同期群的总净收入（美元）

total_anrpas_usdnumber

每位活跃订阅者的平均净收入（ANRPAS，美元）总计

total_appas_usdnumber

每位活跃订阅者的平均收益（APPAS，美元）总计

total_arpas_usdnumber

每位活跃订阅者的平均收入（ARPAS，美元）总计

total_anrppu_usdnumber

每位付费用户的平均净收入（ANRPPU，美元）总计

total_apppu_usdnumber

每位付费用户的平均收益（APPPU，美元）总计

total_arppu_usdnumber

每位付费用户的平均收入（ARPPU，美元）总计

total_anrpu_usdnumber

每位用户的平均净收入（ANRPU，美元）总计

total_appu_usdnumber

每位用户的平均收益（APPU，美元）总计

total_arpu_usdnumber

每位用户的平均收入（ARPU，美元）总计

predictobject

该同期群的趋势预测数据（如有）

valuesarray of object

按周期划分的数组，展示同期群随时间推移的表现

arpas_usdnumber

该周期每位活跃订阅者的平均收入（美元）

appas_usdnumber

该周期每位活跃订阅者的平均净收益（美元）

anrpas_usdnumber

该周期每位活跃订阅者的平均净营收（美元）

anrppu_usdnumber

该周期每位付费用户的平均净营收（美元）

apppu_usdnumber

该周期每位付费用户的平均净收益（美元）

arppu_usdnumber

该周期每位付费用户的平均收入（美元）

anrpu_usdnumber

该周期每位用户的平均净营收（美元）

appu_usdnumber

该周期每位用户的平均净收益（美元）

arpu_usdnumber

该周期每位用户的平均收入（美元）

installsinteger

该周期的应用安装数量

periodinteger

周期编号（1 = 第一个周期，2 = 第二个周期，以此类推）

revenue_usdnumber

该周期的总收入（美元）

proceeds_usdnumber

该周期的总净收益（美元，扣除应用商店手续费后）

net_revenue_usdnumber

该周期的总净营收（美元）

revenue_relativenumber

收入相对于第一个周期的百分比（100% = 第一个周期）

proceeds_relativenumber

净收益相对于第一个周期的百分比（100% = 第一个周期）

net_revenue_relativenumber

净营收相对于第一个周期的百分比（100% = 第一个周期）

subscriptionsinteger

该周期的订阅数量

subscriptions_relativenumber

订阅数量相对于第一个周期的百分比（100% = 第一个周期）

subscribersinteger

该周期的订阅者数量

subscribers_relativenumber

订阅者数量相对于第一个周期的百分比（100% = 第一个周期）

currently_active_periodboolean

该周期是否为同期群当前活跃的周期

Example

{
  "data": [
    {
      "segment_start_date": "2024-04-01",
      "type": "total",
      "title": "Total",
      "total_installs": 0,
      "total_subscriptions": 0,
      "total_paid_subscribers": 0,
      "total_revenue_usd": 0,
      "total_proceeds_usd": 0,
      "total_net_revenue_usd": 0,
      "total_anrpas_usd": 0,
      "total_appas_usd": 0,
      "total_arpas_usd": 0,
      "total_anrppu_usd": 0,
      "total_apppu_usd": 0,
      "total_arppu_usd": 0,
      "total_anrpu_usd": 0,
      "total_appu_usd": 0,
      "total_arpu_usd": 0,
      "predict": null,
      "values": [
        {
          "arpas_usd": 0,
          "appas_usd": 0,
          "anrpas_usd": 0,
          "anrppu_usd": 0,
          "apppu_usd": 0,
          "arppu_usd": 0,
          "anrpu_usd": 0,
          "appu_usd": 0,
          "arpu_usd": 0,
          "installs": 0,
          "period": 1,
          "revenue_usd": 0,
          "proceeds_usd": 0,
          "net_revenue_usd": 0,
          "revenue_relative": 0,
          "proceeds_relative": 0,
          "net_revenue_relative": 0,
          "subscriptions": 0,
          "subscriptions_relative": 0,
          "subscribers": 0,
          "subscribers_relative": 0,
          "currently_active_period": false
        }
      ]
    }
  ]
}

错误请求

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

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-04-01",
        "2024-09-30"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ]
    },
    "period_unit": "month",
    "period_type": "renewals",
    "value_type": "absolute",
    "value_field": "subscriptions"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-04-01",
        "2024-09-30"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ]
    },
    "period_unit": "month",
    "period_type": "renewals",
    "value_type": "absolute",
    "value_field": "subscriptions"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/cohort/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-04-01",
          "2024-09-30"
        ],
        "store": [
          "app_store"
        ],
        "country": [
          "us"
        ]
      },
      "period_unit": "month",
      "period_type": "renewals",
      "value_type": "absolute",
      "value_field": "subscriptions"
    })
data = response.json()