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

获取生命周期价值 (LTV) 数据

Copy as Markdown

获取 LTV 数据，以评估客户在其参与期间的长期收入潜力。

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

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

超出速率限制。每个应用每秒最多 2 次请求，由该应用的所有 API 密钥共享。

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ],
      "offer_category": [
        "introductory"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ],
      "attribution_source": [
        "appsflyer"
      ],
      "attribution_status": [
        "organic"
      ],
      "attribution_channel": [
        "social_media"
      ]
    },
    "period_unit": "quarter",
    "period_type": "renewals",
    "segmentation": "store_product_id",
    "format": "csv"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ],
      "offer_category": [
        "introductory"
      ],
      "store": [
        "app_store"
      ],
      "country": [
        "us"
      ],
      "attribution_source": [
        "appsflyer"
      ],
      "attribution_status": [
        "organic"
      ],
      "attribution_channel": [
        "social_media"
      ]
    },
    "period_unit": "quarter",
    "period_type": "renewals",
    "segmentation": "store_product_id",
    "format": "csv"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/ltv/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ],
        "compare_date": [
          "2023-01-01",
          "2023-12-31"
        ],
        "offer_category": [
          "introductory"
        ],
        "store": [
          "app_store"
        ],
        "country": [
          "us"
        ],
        "attribution_source": [
          "appsflyer"
        ],
        "attribution_status": [
          "organic"
        ],
        "attribution_channel": [
          "social_media"
        ]
      },
      "period_unit": "quarter",
      "period_type": "renewals",
      "segmentation": "store_product_id",
      "format": "csv"
    })
data = response.json()