POST /api/v1/client-api/metrics/conversion/

Truy xuất dữ liệu chuyển đổi

Truy xuất dữ liệu chuyển đổi để phân tích hành động của người dùng và đo lường hiệu quả của các nỗ lực marketing theo thời gian.

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 thực hiện giao dịch mua

countryarray of string

Lọc theo mã quốc gia 2 chữ cái nơi thực hiện giao dịch mua

store_product_idarray of string

Mã định danh duy nhất của sản phẩm từ cửa hàng ứng dụng

durationarray of string

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

attribution_sourcearray of string

Nguồn tích hợp 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

from_periodstring | nullrequired

Trạng thái gói đăng ký ban đầu của người dùng trong quá trình chuyển đổi

to_periodstringrequired

Trạng thái gói đăng ký mới của người dùng sau khi chuyển đổi

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"

date_typestring

Chỉ định ngày nào sẽ được coi là ngày người dùng tham gia

One of: "purchase_date", "profile_install_date"

segmentationstring

Đặt cơ sở để phân khúc

formatstring

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

One of: "json", "csv"

Responses

Đã truy xuất dữ liệu chuyển đổi thành công

Schema

Phản hồi chứa dữ liệu chuyển đổi hiển thị hành trình của người dùng giữa các trạng thái gói đăng ký

dataarray of object

Mảng các điểm dữ liệu chuyển đổi (có thể rỗng đối với các chỉ số tổng hợp)

valuenumber

Giá trị tỷ lệ chuyển đổi

value_frominteger

Trạng thái gói đăng ký ban đầu cho quá trình chuyển đổi

value_tointeger

Trạng thái gói đăng ký mục tiêu cho quá trình chuyển đổi

compare_value_fromnumber

Giá trị bắt đầu cho kỳ so sánh

compare_value_tonumber

Giá trị kết thúc cho kỳ so sánh

titlestring

Tiêu đề hiển thị mô tả loại chuyển đổi

typestring

Loại chỉ số chuyển đổi

default_aggregationstring

Phương pháp tổng hợp mặc định cho chỉ số này

descriptionstring

Giải thích chi tiết về cách tính tỷ lệ chuyển đổi

metric_namestring

Tên nội bộ của chỉ số chuyển đổi

is_jsonboolean

Dữ liệu có ở định dạng JSON hay không

unitstring

Đơn vị đo lường (thường là 'percent' cho tỷ lệ chuyển đổi)

recommended_periodobject

Khoảng ngày được đề xuất cho chỉ số chuyển đổi này

date_fromstring

Ngày bắt đầu của kỳ được đề xuất

date_tostring

Ngày kết thúc của kỳ được đề xuất

period_unitstring

Đơn vị kỳ được đề xuất

Example

{
  "data": [],
  "value": 0,
  "value_from": 0,
  "value_to": 0,
  "compare_value_from": null,
  "compare_value_to": null,
  "title": "Conversion rate from Paid to more than 6 months",
  "type": "multi",
  "default_aggregation": "sum",
  "description": "If Х - the number of the 1st payments taken during the selected date, and Y - the amount of the renewals that happened after the 6 months since the selected date from those 1st payments, then Conversion = (Y / X) * 100%. For example, we had 100 1st subscriptions of various products on the 1st of January and among them 20 renewed on the 1st week of July (the 25th payment). On the 8th of July, we open the chart and see the conversion of the 1st of January = (20 / 100) * 100% = 20%. Then 30 more subscribers of the 1st of January renewed by the start of August (the 8th payment). We open the chart on the 1st of August and see that the conversion of the 1st of January = ((20+30) / 100) * 100% = 50%. This number shows which part of those who had their 1st payment on the 1st of January converted to the period > 6 months with any number of payments by the current moment.",
  "metric_name": "from_paid_to_6_months_conversion",
  "is_json": true,
  "unit": "percent",
  "recommended_period": {
    "date_from": "2018-04-29",
    "date_to": "2024-12-31",
    "period_unit": "month"
  }
}

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 API key.

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', {
  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"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ]
      },
      "from_period": 1,
      "to_period": "6+",
      "period_unit": "month",
      "date_type": "purchase_date",
      "segmentation": "country",
      "format": "json"
    })
data = response.json()