POST /api/v1/client-api/metrics/ltv/

LTV(ライフタイムバリュー)データの取得

顧客のエンゲージメント期間における長期的な収益ポテンシャルを評価するためのLTVデータを取得します。

レート制限: 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"

segmentationstring

データをこのディメンションの値ごとに系列に分割します。例えば、flow_id はフローごとに個別の系列を返し、placement_id はプレースメントごとに個別の系列を返します。

One of: "period", "renewal_status", "cancellation_reason", "store_product_id", "country", "store", "paywall_id", "audience_id", "placement_id", "flow_id", "flow_screen_id", "segment_id", "duration", "offer_category", "offer_type", "offer_id", "attribution_source", "attribution_status", "attribution_channel", "attribution_campaign", "attribution_adgroup", "attribution_adset", "attribution_creative", "day", "week", "month", "year"

formatstring

エクスポートファイルの形式を指定します

One of: "json", "csv"

Responses

LTVデータが正常に取得されました

Schema

異なる収益タイプのライフタイムバリュー(LTV)データを含むレスポンス

revenueobject

総収益を使用して計算されたLTV

dataarray of object

異なるコホートのLTVデータポイントの配列

titlestring

このLTVデータポイントの表示タイトル

typestring

LTVデータのタイプ(集計データの場合は 'total')

valuenumber

このコホートのLTV値

valuesarray of object

期間ベースのLTV値の配列

cohort_sizeinteger

このコホートのユーザー数

descriptionstring

LTVの計算方法を説明するHTML形式の説明

valuenumber

LTVの総合的な値

unitstring

測定単位(通常は「USD」)

titlestring

このLTV指標の表示タイトル

proceedsobject

手取り額(ストア手数料控除後)を使用して計算されたLTV

dataarray of object

異なるコホートのLTVデータポイントの配列

titlestring

このLTVデータポイントの表示タイトル

typestring

LTVデータのタイプ(集計データの場合は 'total')

valuenumber

このコホートのLTV値

valuesarray of object

期間ベースのLTV値の配列

cohort_sizeinteger

このコホートのユーザー数

descriptionstring

LTVの計算方法を説明するHTML形式の説明

valuenumber

LTVの総合的な値

unitstring

測定単位(通常は「USD」)

titlestring

このLTV指標の表示タイトル

net_revenueobject

純収益を使用して計算されたLTV

dataarray of object

異なるコホートのLTVデータポイントの配列

titlestring

このLTVデータポイントの表示タイトル

typestring

LTVデータのタイプ(集計データの場合は 'total')

valuenumber

このコホートのLTV値

valuesarray of object

期間ベースのLTV値の配列

cohort_sizeinteger

このコホートのユーザー数

descriptionstring

LTVの計算方法を説明するHTML形式の説明

valuenumber

LTVの総合的な値

unitstring

測定単位(通常は「USD」)

titlestring

このLTV指標の表示タイトル

Example
{
  "revenue": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  },
  "proceeds": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  },
  "net_revenue": {
    "data": [
      {
        "title": "Total",
        "type": "total",
        "value": 0,
        "values": [],
        "cohort_size": 0
      }
    ],
    "description": "<div>LTV (Lifetime Value) is calculated as revenue for the period / number of subscribers on start.\n It's an actual, not predicted LTV.\n <a target=\"_blank\" rel=\"noopener noreferrer\" href='https://adapty.io/docs/ltv'> Read more</a>.</div>",
    "value": 0,
    "unit": "USD",
    "title": "LTV"
  }
}

リクエストが不正です

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リクエストです。