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

ストア修飾プロダクト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

データを取得する特定のオファーを指定してください

placement_idarray of string

データを取得するプレースメントの Adapty 内部ID。SDKに渡すプレースメントIDではなく、ダッシュボードURLに含まれるUUIDを指定してください。

audience_idarray of string

データを取得するプレースメントオーディエンスの Adapty 内部ID

paywall_idarray of string

データを取得するペイウォールの Adapty 内部ID。ダッシュボードURLに含まれるUUIDを指定してください。

flow_idarray of string

データを取得するフローの Adapty 内部ID。ダッシュボード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

このコホートの総収益（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()