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

Truy xuất dữ liệu Lifetime Value (LTV)

Copy as Markdown

Truy xuất dữ liệu LTV để đánh giá tiềm năng doanh thu dài hạn của khách hàng trong suốt thời gian tương tác của họ.

Giới hạn tốc độ: 2 yêu cầu mỗi giây.

Request body

filtersobjectrequired

datearray of stringrequired

Nhập ngày hoặc khoảng thời gian bạn muốn truy xuất dữ liệu biểu đồ

compare_datearray of string

Nhập ngày hoặc khoảng thời gian để so sánh

storearray of string

Lọc theo cửa hàng ứng dụng nơi giao dịch mua được thực hiện

countryarray of string

Lọc theo mã quốc gia 2 chữ cái nơi giao dịch mua diễn ra

store_product_idarray of string

ID sản phẩm có kèm tên cửa hàng, được định dạng theo cú pháp <store>:<product_id> — ví dụ app_store:premium_monthly hoặc play_store:premium_sub:monthly-base-plan đối với gói đăng ký Google có base plan. ID sản phẩm không có tiền tố cửa hàng sẽ bị từ chối.

durationarray of string

Chỉ định thời hạn gói đăng ký

attribution_sourcearray of string

Tích hợp nguồn cho attribution

attribution_statusarray of string

Cho biết attribution là organic hay non-organic

attribution_channelarray of string

Kênh marketing dẫn đến giao dịch

attribution_campaignarray of string

Chiến dịch marketing mang lại giao dịch

attribution_adgrouparray of string

Nhóm quảng cáo attribution mang lại giao dịch

attribution_adsetarray of string

Bộ quảng cáo attribution dẫn đến giao dịch

attribution_creativearray of string

Các yếu tố hình ảnh hoặc văn bản cụ thể trong quảng cáo hoặc chiến dịch được theo dõi để đo lường hiệu quả

offer_categoryarray of string

Chỉ định các danh mục ưu đãi bạn muốn truy xuất dữ liệu

offer_typearray of string

Chỉ định các loại ưu đãi bạn muốn truy xuất dữ liệu

offer_idarray of string

Chỉ định các ưu đãi cụ thể bạn muốn truy xuất dữ liệu

placement_idarray of string

ID nội bộ của Adapty cho các placement cần truy xuất dữ liệu — UUID trong URL placement trên dashboard, không phải ID placement bạn truyền vào SDK

audience_idarray of string

ID nội bộ của Adapty cho các đối tượng của placement cần truy xuất dữ liệu

paywall_idarray of string

ID nội bộ của Adapty cho các paywall cần truy xuất dữ liệu — UUID trong URL paywall trên dashboard

flow_idarray of string

ID nội bộ của Adapty cho các flow cần truy xuất dữ liệu — UUID trong URL flow trên dashboard

flow_screen_idarray of string

Các màn hình flow cần truy xuất dữ liệu, mỗi mục được định dạng theo cú pháp <flow_id>:<screen_id> — ví dụ 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

ID nội bộ của Adapty cho các phân khúc cần truy xuất dữ liệu

period_unitstring

Chỉ định khoảng thời gian để tổng hợp dữ liệu phân tích

One of: "day", "week", "month", "quarter", "year"

period_typestring

Phân tích dữ liệu theo số lần gia hạn hoặc theo số ngày

One of: "renewals", "days"

segmentationstring

Chia dữ liệu thành một chuỗi riêng cho mỗi giá trị của chiều này. Ví dụ, flow_id trả về một chuỗi riêng biệt cho mỗi flow, và placement_id cho mỗi placement.

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

Chỉ định định dạng tệp xuất

One of: "json", "csv"

Responses

Dữ liệu LTV được truy xuất thành công

Schema

Phản hồi chứa dữ liệu Lifetime Value (LTV) cho các loại doanh thu khác nhau

revenueobject

LTV được tính dựa trên doanh thu gộp

dataarray of object

Mảng các điểm dữ liệu LTV cho các cohort khác nhau

titlestring

Tiêu đề hiển thị cho điểm dữ liệu LTV này

typestring

Loại dữ liệu LTV ('total' cho dữ liệu tổng hợp)

valuenumber

Giá trị LTV cho cohort này

valuesarray of object

Mảng các giá trị LTV theo từng kỳ

cohort_sizeinteger

Số lượng người dùng trong cohort này

descriptionstring

Mô tả HTML giải thích cách tính LTV

valuenumber

Giá trị LTV tổng thể

unitstring

Đơn vị đo lường (thường là 'USD')

titlestring

Tiêu đề hiển thị cho chỉ số LTV này

proceedsobject

LTV được tính dựa trên số tiền thực nhận (sau khi trừ phí cửa hàng)

dataarray of object

Mảng các điểm dữ liệu LTV cho các cohort khác nhau

titlestring

Tiêu đề hiển thị cho điểm dữ liệu LTV này

typestring

Loại dữ liệu LTV ('total' cho dữ liệu tổng hợp)

valuenumber

Giá trị LTV cho cohort này

valuesarray of object

Mảng các giá trị LTV theo từng kỳ

cohort_sizeinteger

Số lượng người dùng trong cohort này

descriptionstring

Mô tả HTML giải thích cách tính LTV

valuenumber

Giá trị LTV tổng thể

unitstring

Đơn vị đo lường (thường là 'USD')

titlestring

Tiêu đề hiển thị cho chỉ số LTV này

net_revenueobject

LTV được tính dựa trên doanh thu thuần

dataarray of object

Mảng các điểm dữ liệu LTV cho các cohort khác nhau

titlestring

Tiêu đề hiển thị cho điểm dữ liệu LTV này

typestring

Loại dữ liệu LTV ('total' cho dữ liệu tổng hợp)

valuenumber

Giá trị LTV cho cohort này

valuesarray of object

Mảng các giá trị LTV theo từng kỳ

cohort_sizeinteger

Số lượng người dùng trong cohort này

descriptionstring

Mô tả HTML giải thích cách tính LTV

valuenumber

Giá trị LTV tổng thể

unitstring

Đơn vị đo lường (thường là 'USD')

titlestring

Tiêu đề hiển thị cho chỉ số LTV này

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"
  }
}

Yêu cầu không hợp lệ

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Không được phép

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Vượt quá giới hạn tốc độ. Tối đa 2 yêu cầu mỗi giây cho mỗi ứng dụng, được chia sẻ bởi tất cả các API key của ứng dụng đó.

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