跳转到主要内容
POST
查询漏斗转化

限制说明

使用说明

  • start_time 与 end_time 为 Unix 毫秒时间戳。两者都省略时取最近 7 天;超过 14 天会返回 InvalidParameter。
  • 调用方需对 application_id 有读权限;无权访问的私有应用数据不参与统计。
  • compare 按出现最多的两个取值拆分漏斗并在 groups 返回;不传时 groups 为空数组。
  • steps[].duration_p50 在首步或没有找到有序路径时为 null。
  • 查询超时或排队过久会返回客户端错误,请缩小时间窗或步骤范围。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

运行一个漏斗定义,并可按维度拆分。

application_id
string
必填

RUM 应用 ID。调用方需对该应用有读权限,写操作需要管理权限。

definition
object
必填

漏斗定义:有序步骤、计数单位与可选过滤条件。允许 2-10 个步骤。

compare
enum<string>

按该维度拆分漏斗并返回出现最多的两个取值;省略则只返回整体漏斗。拆分维度:env、version、device_type、browser_name、os_name、geo_country,即 views 与 actions 两张表共有的列。

可用选项:
env,
version,
device_type,
browser_name,
os_name,
geo_country
end_time
integer<int64>

时间窗终点,Unix 毫秒时间戳。省略时取当前时间。

示例:

1780358400000

start_time
integer<int64>

时间窗起点,Unix 毫秒时间戳。两个边界都省略时取最近 7 天;超过 14 天的范围会被拒绝。

示例:

1780272000000

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

整体漏斗结果,以及在对比维度上的拆分结果。