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

コホートデータの取得

ユーザーグループを時系列で追跡するためのコホートデータを取得します。

このエンドポイントの収益はインストール日コホートベースです。各ユーザーの収益はトランザクション日ではなくインストール日に紐付けられます。レスポンスには total_revenue_usd と total_proceeds_usd が含まれます。インストール日ベースでもある Ads Manager との内部レポート照合には、アナリティクスエンドポイントではなくこのエンドポイントを使用してください。

レート制限：1 秒あたり 2 リクエスト。

Request body

filtersobjectrequired

datearray of stringrequired

チャートデータを取得する日付または期間を入力します

compare_datearray of string

比較する日付または期間を入力します

storearray of string

購入が行われたアプリストアでフィルタリングします

countryarray of string

購入が行われた国の 2 文字の国コードでフィルタリングします

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

アクティブサブスクライバー 1 人あたりの平均純収益（ANRPAS）（USD）の合計

total_appas_usdnumber

アクティブサブスクライバー 1 人あたりの平均プロシード（APPAS）（USD）の合計

total_arpas_usdnumber

アクティブサブスクライバー 1 人あたりの平均収益（ARPAS）（USD）の合計

total_anrppu_usdnumber

有料ユーザー 1 人あたりの平均純収益（ANRPPU）（USD）の合計

total_apppu_usdnumber

有料ユーザー 1 人あたりの平均プロシード（APPPU）（USD）の合計

total_arppu_usdnumber

有料ユーザー 1 人あたりの平均収益（ARPPU）（USD）の合計

total_anrpu_usdnumber

ユーザー 1 人あたりの平均純収益（ANRPU）（USD）の合計

total_appu_usdnumber

ユーザー 1 人あたりの平均プロシード（APPU）（USD）の合計

total_arpu_usdnumber

ユーザー 1 人あたりの平均収益（ARPU）（USD）の合計

predictobject

このコホートの予測データ（利用可能な場合）

valuesarray of object

コホートの時系列パフォーマンスを示す期間別値の配列

arpas_usdnumber

この期間のアクティブサブスクライバー 1 人あたりの平均収益（USD）

appas_usdnumber

この期間のアクティブサブスクライバー 1 人あたりの平均プロシード（USD）

anrpas_usdnumber

この期間のアクティブサブスクライバー 1 人あたりの平均純収益（USD）

anrppu_usdnumber

この期間の有料ユーザー 1 人あたりの平均純収益（USD）

apppu_usdnumber

この期間の有料ユーザー 1 人あたりの平均プロシード（USD）

arppu_usdnumber

この期間の有料ユーザー 1 人あたりの平均収益（USD）

anrpu_usdnumber

この期間のユーザー 1 人あたりの平均純収益（USD）

appu_usdnumber

この期間のユーザー 1 人あたりの平均プロシード（USD）

arpu_usdnumber

この期間のユーザー 1 人あたりの平均収益（USD）

installsinteger

この期間のアプリインストール数

periodinteger

期間番号（1 = 第 1 期間、2 = 第 2 期間など）

revenue_usdnumber

この期間の総収益（USD）

proceeds_usdnumber

この期間の総プロシード（USD、ストア手数料控除後）

net_revenue_usdnumber

この期間の総純収益（USD）

revenue_relativenumber

第 1 期間を基準とした収益の割合（100% = 第 1 期間）

proceeds_relativenumber

第 1 期間を基準としたプロシードの割合（100% = 第 1 期間）

net_revenue_relativenumber

第 1 期間を基準とした純収益の割合（100% = 第 1 期間）

subscriptionsinteger

この期間のサブスクリプション数

subscriptions_relativenumber

第 1 期間を基準としたサブスクリプションの割合（100% = 第 1 期間）

subscribersinteger

この期間のサブスクライバー数

subscribers_relativenumber

第 1 期間を基準としたサブスクライバーの割合（100% = 第 1 期間）

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

レート制限を超過しました。API キーごとに 1 秒あたり最大 2 リクエストです。

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