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

Truy xuất dữ liệu cohort

Truy xuất dữ liệu cohort để theo dõi các nhóm người dùng theo thời gian.

Doanh thu từ endpoint này dựa trên cohort theo ngày cài đặt: doanh thu của mỗi người dùng được quy cho ngày cài đặt của họ, không phải ngày giao dịch. Phản hồi hiển thị total_revenue_usd và total_proceeds_usd. Sử dụng endpoint này (thay vì endpoint analytics) để đối chiếu báo cáo nội bộ với Ads Manager, vốn cũng dựa trên cohort/ngày cài đặt.

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 lần gia hạn hoặc theo ngày

One of: "renewals", "days"

value_typestring

Chỉ định cách hiển thị các giá trị

One of: "absolute", "relative"

value_fieldstring

Chỉ định loại giá trị được hiển thị

One of: "revenue", "arppu", "arpu", "arpas", "subscribers", "subscriptions"

accounting_typestring

Phương pháp kế toán được sử dụng

One of: "revenue", "proceeds", "net_revenue"

renewal_daysarray of integer

Danh sách số ngày kể từ khi cài đặt ứng dụng cho loại cohort period_type=days

prediction_monthsinteger

Nhập số tháng dự đoán bạn muốn

One of: 3, 6, 9, 12, 18, 24

formatstring

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

One of: "json", "csv"

Responses

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

Schema

Phản hồi chứa dữ liệu phân tích cohort cho thấy hành vi người dùng theo thời gian

dataarray of object

Mảng các phân khúc cohort, mỗi phân khúc đại diện cho một nhóm người dùng bắt đầu trong cùng một khoảng thời gian

segment_start_datestring

Ngày bắt đầu của phân khúc cohort này

typestring

Loại phân khúc ('total' cho dữ liệu tổng hợp, 'single' cho cohort riêng lẻ)

titlestring

Tiêu đề hiển thị cho phân khúc cohort này

total_installsinteger

Tổng số lần cài đặt ứng dụng trong cohort này

total_subscriptionsinteger

Tổng số gói đăng ký trong cohort này

total_paid_subscribersinteger

Tổng số người đăng ký trả phí trong cohort này

total_revenue_usdnumber

Tổng doanh thu tính bằng USD cho cohort này

total_proceeds_usdnumber

Tổng tiền thu về tính bằng USD cho cohort này (sau khi trừ phí cửa hàng)

total_net_revenue_usdnumber

Tổng doanh thu ròng tính bằng USD cho cohort này

total_anrpas_usdnumber

Tổng Doanh thu trung bình trên mỗi người đăng ký đang hoạt động (ANRPAS) tính bằng USD

total_appas_usdnumber

Tổng Tiền thu về trung bình trên mỗi người đăng ký đang hoạt động (APPAS) tính bằng USD

total_arpas_usdnumber

Tổng Doanh thu trung bình trên mỗi người đăng ký đang hoạt động (ARPAS) tính bằng USD

total_anrppu_usdnumber

Tổng Doanh thu trung bình trên mỗi người dùng trả phí (ANRPPU) tính bằng USD

total_apppu_usdnumber

Tổng Tiền thu về trung bình trên mỗi người dùng trả phí (APPPU) tính bằng USD

total_arppu_usdnumber

Tổng Doanh thu trung bình trên mỗi người dùng trả phí (ARPPU) tính bằng USD

total_anrpu_usdnumber

Tổng Doanh thu trung bình trên mỗi người dùng (ANRPU) tính bằng USD

total_appu_usdnumber

Tổng Tiền thu về trung bình trên mỗi người dùng (APPU) tính bằng USD

total_arpu_usdnumber

Tổng Doanh thu trung bình trên mỗi người dùng (ARPU) tính bằng USD

predictobject

Dữ liệu dự đoán cho cohort này (nếu có)

valuesarray of object

Mảng các giá trị theo kỳ hiển thị hiệu suất của cohort theo thời gian

arpas_usdnumber

Doanh thu trung bình trên mỗi người đăng ký đang hoạt động (USD) trong kỳ này

appas_usdnumber

Doanh thu ròng trung bình trên mỗi người đăng ký đang hoạt động (USD) trong kỳ này

anrpas_usdnumber

Doanh thu ròng trung bình trên mỗi người đăng ký đang hoạt động (USD) trong kỳ này

anrppu_usdnumber

Doanh thu ròng trung bình trên mỗi người dùng trả phí (USD) trong kỳ này

apppu_usdnumber

Doanh thu ròng trung bình trên mỗi người dùng trả phí (USD) trong kỳ này

arppu_usdnumber

Doanh thu trung bình trên mỗi người dùng trả phí (USD) trong kỳ này

anrpu_usdnumber

Doanh thu ròng trung bình trên mỗi người dùng (USD) trong kỳ này

appu_usdnumber

Doanh thu ròng trung bình trên mỗi người dùng (USD) trong kỳ này

arpu_usdnumber

Doanh thu trung bình trên mỗi người dùng (USD) trong kỳ này

installsinteger

Số lượt cài đặt ứng dụng trong kỳ này

periodinteger

Số thứ tự kỳ (1 = kỳ đầu tiên, 2 = kỳ thứ hai, v.v.)

revenue_usdnumber

Tổng doanh thu (USD) trong kỳ này

proceeds_usdnumber

Tổng doanh thu ròng (USD) trong kỳ này (sau khi trừ phí cửa hàng)

net_revenue_usdnumber

Tổng doanh thu thuần (USD) trong kỳ này

revenue_relativenumber

Doanh thu theo phần trăm so với kỳ đầu tiên (100% = kỳ đầu tiên)

proceeds_relativenumber

Doanh thu ròng theo phần trăm so với kỳ đầu tiên (100% = kỳ đầu tiên)

net_revenue_relativenumber

Doanh thu thuần theo phần trăm so với kỳ đầu tiên (100% = kỳ đầu tiên)

subscriptionsinteger

Số lượng gói đăng ký trong kỳ này

subscriptions_relativenumber

Số gói đăng ký theo phần trăm so với kỳ đầu tiên (100% = kỳ đầu tiên)

subscribersinteger

Số người đăng ký trong kỳ này

subscribers_relativenumber

Số người đăng ký theo phần trăm so với kỳ đầu tiên (100% = kỳ đầu tiên)

currently_active_periodboolean

Cho biết đây có phải là kỳ đang hoạt động hiện tại của cohort hay không

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

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 truy cậ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 trên mỗi ứng dụng, dùng chung cho 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/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()