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

获取转化数据

Copy as Markdown

获取转化数据，以分析用户行为并衡量营销工作随时间推移的效果。

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

from_periodstring | nullrequired

用户转化前的订阅起始状态

to_periodstringrequired

用户转化后的新订阅状态

period_unitstring

指定聚合分析数据的时间间隔

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

date_typestring

指定将哪个日期作为用户加入日期

One of: "purchase_date", "profile_install_date"

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

转化数据获取成功

Schema

包含转化数据的响应，展示用户在订阅状态之间的流转情况

dataarray of object

转化数据点数组（聚合数据图表可能为空）

valuenumber

转化率数值

value_frominteger

转化的起始订阅状态

value_tointeger

转化的目标订阅状态

compare_value_fromnumber

对比周期的起始值

compare_value_tonumber

对比周期的结束值

titlestring

描述转化类型的显示标题

typestring

转化数据图表的类型

default_aggregationstring

该数据图表的默认聚合方式

descriptionstring

转化率计算方式的详细说明

metric_namestring

转化数据图表的内部名称

is_jsonboolean

数据是否为 JSON 格式

unitstring

计量单位（转化率通常为 'percent'）

recommended_periodobject

该转化数据图表的建议日期范围

date_fromstring

建议周期的开始日期

date_tostring

建议周期的结束日期

period_unitstring

建议的周期单位

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

请求无效

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