跳转到主要内容
POST
查询热力图元素排行

限制说明

使用说明

  • start_time 与 end_time 为 Unix 毫秒时间戳。两者都省略时取最近 7 天;超过 14 天会返回 InvalidParameter。
  • 调用方需对 application_id 有读权限;无权访问的私有应用数据不参与统计。
  • page 必填;min_width / max_width 把浏览限定在一个视口宽度区间(max_width 为开区间)。
  • 传 cohort 可只统计某个漏斗转化的计数单位。
  • 点击量少于 100 的元素不给百分比字段(null);元素的 units 除以 page_units 即其点击率。

授权

app_key
string
query
必填

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

请求体

application/json

把热力图查询限定到一个页面,可选限定视口宽度与人群。

application_id
string
必填

RUM 应用 ID。调用方需对该应用有读权限。

page
string
必填

热力图针对的页面路径组,例如 /checkout。必填。

cohort
object

把热力图限定在某个漏斗转化的计数单位上;省略表示不限人群。

end_time
integer<int64>

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

示例:

1780358400000

max_width
integer

视口宽度的开区间上界:只纳入窄于 max_width 的浏览。0 或省略表示不设上限;两者都设置时必须大于 min_width。

必填范围: x >= 0
min_width
integer

纳入的最小视口宽度(CSS 像素)。0 或省略表示不设下限。

必填范围: x >= 0
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

页面的元素点击排行。