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

获取同期群数据

Copy as Markdown

获取同期群数据，以追踪用户群体随时间的变化情况。

Request body

filtersobjectrequired

datearray of stringrequired

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

compare_datearray of string

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

storearray of string

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

countryarray of string

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

store_product_idarray of string

应用商店中产品的唯一标识符

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"

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

该同期群的 USD 总收入

total_proceeds_usdnumber

该同期群扣除商店手续费后的 USD 总收益

total_net_revenue_usdnumber

该同期群的 USD 净收入总额

total_anrpas_usdnumber

每位活跃订阅者平均净收入（ANRPAS），单位 USD

total_appas_usdnumber

每位活跃订阅者平均收益（APPAS），单位 USD

total_arpas_usdnumber

每位活跃订阅者平均收入（ARPAS），单位 USD

total_anrppu_usdnumber

每位付费用户平均净收入（ANRPPU），单位 USD

total_apppu_usdnumber

每位付费用户平均收益（APPPU），单位 USD

total_arppu_usdnumber

每位付费用户平均收入（ARPPU），单位 USD

total_anrpu_usdnumber

每位用户平均净收入（ANRPU），单位 USD

total_appu_usdnumber

每位用户平均收益（APPU），单位 USD

total_arpu_usdnumber

每位用户平均收入（ARPU），单位 USD

predictobject

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

valuesarray of object

基于时间段的数值数组，展示同期群随时间的表现

arpas_usdnumber

该时间段每位活跃订阅者平均收入，单位 USD

appas_usdnumber

该时间段每位活跃订阅者平均收益，单位 USD

anrpas_usdnumber

该时间段每位活跃订阅者平均净收入，单位 USD

anrppu_usdnumber

该时间段每位付费用户平均净收入，单位 USD

apppu_usdnumber

该时间段每位付费用户平均收益，单位 USD

arppu_usdnumber

该时间段每位付费用户平均收入，单位 USD

anrpu_usdnumber

该时间段每位用户平均净收入，单位 USD

appu_usdnumber

该时间段每位用户平均收益，单位 USD

arpu_usdnumber

该时间段每位用户平均收入，单位 USD

installsinteger

该时间段的应用安装数量

periodinteger

时间段编号（1 = 第一个时间段，2 = 第二个时间段，以此类推）

revenue_usdnumber

该时间段的 USD 总收入

proceeds_usdnumber

该时间段扣除商店手续费后的 USD 总收益

net_revenue_usdnumber

该时间段的 USD 净收入总额

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

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()