English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/client-api/metrics/funnel/

Truy xuất dữ liệu funnel

Copy as Markdown

Truy xuất dữ liệu funnel để theo dõi tiến trình của người dùng qua các giai đoạn cụ thể của quá trình chuyển đổi.

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

show_value_asstring

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

One of: "absolute", "relative", "both"

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

Truy xuất dữ liệu funnel thành công

Schema

Phản hồi chứa dữ liệu phân tích phễu hiển thị tiến trình của người dùng qua các giai đoạn chuyển đổi

dataarray of object

Mảng các phân khúc phễu hiển thị các giai đoạn khác nhau của quá trình chuyển đổi

titlestring

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

typestring

Loại phân khúc phễu ('total' cho dữ liệu tổng hợp)

valuesarray of object

Mảng các giá trị phễu hiển thị tiến trình qua các giai đoạn

periodinteger

Số thứ tự giai đoạn trong phễu (-2 = Cài đặt, -1 = Hiển thị paywall, v.v.)

titlestring

Tiêu đề hiển thị cho giai đoạn phễu này

valueinteger

Số người dùng đã đến giai đoạn này

value_relativenumber

Tỷ lệ phần trăm người dùng đã đến giai đoạn này so với giai đoạn đầu tiên

relative_changesnumber

Thay đổi tỷ lệ chuyển đổi so với giai đoạn trước

following_changesobject

Thông tin về người dùng đã rời bỏ sau giai đoạn này

titlestring

Tiêu đề cho giai đoạn rời bỏ

valueinteger

Số người dùng đã rời bỏ

value_relativenumber

Tỷ lệ phần trăm người dùng đã rời bỏ

churn_reason_titlestring

Tiêu đề mô tả lý do rời bỏ tại giai đoạn này

churn_reasonsarray of object

Mảng các lý do rời bỏ cụ thể

valuesarray of object

Các giá trị lồng nhau bổ sung cho giai đoạn phễu này

Example 
{
  "data": [
    {
      "title": "Total",
      "type": "total",
      "values": [
        {
          "period": -2,
          "title": "Install",
          "value": 2,
          "value_relative": 100,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 2,
            "value_relative": 100
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        },
        {
          "period": -1,
          "title": "Paywall displayed",
          "value": 0,
          "value_relative": 0,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 0,
            "value_relative": 0
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        }
      ]
    }
  ]
}

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 đó.