跳转到主要内容
POST
查询页面路径流向

限制说明

使用说明

  • start_time 与 end_time 为 Unix 毫秒时间戳。两者都省略时取最近 7 天;超过 14 天会返回 InvalidParameter。
  • 调用方需对 application_id 有读权限;无权访问的私有应用数据不参与统计。
  • direction 取 after 或 before;before 必须提供 start,因为会话进入之前没有页面。
  • depth 为跟踪的不同页面数,2-5,默认 3。
  • direction=after 时 to 为空表示会话离开站点;before 时表示会话从该页进入。
  • sample_rate 小于 1 时,sessions 与各项计数已按比例放大。

授权

app_key
string
query
必填

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

请求体

application/json

查询围绕某个页面的页面流向,或从会话进入页开始的流向。

application_id
string
必填

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

direction
enum<string>
必填

沿会话的方向:after 跟踪起始页之后的页面,before 跟踪之前的页面。

可用选项:
after,
before
depth
integer
默认值:3

跟踪的不同页面数量,2-5,默认 3。

必填范围: 2 <= x <= 5
end_time
integer<int64>

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

示例:

1780358400000

filters
object[]

构建流向时对浏览数据应用的过滤条件,省略表示不过滤。

start
string

要跟踪的页面路径组。省略时从会话进入页开始;direction=before 时必须提供。

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

会话围绕某个页面的流转情况,以流向图连线的形式给出。