跳转到主要内容
POST
查询分值分布

时间范围对齐与缓存

为便于重复查询复用缓存结果,起始时间向下、结束时间向上取整到 max(1 分钟, 时间范围 ÷ 1226 向上取到下一个标准间隔档),例如 24 小时对齐到 2 分钟,7 天对齐到 10 分钟,30 天对齐到 1 小时。时间范围短于 100 个网格步长时不对齐、不缓存。起始端最多多出一个网格步长的数据;结束端取整到未来,该部分没有数据。最近时间的数据结果最多可能滞后 60 秒。

限制说明

使用说明

  • 使用 POST /rum/field/list(传 is_facet: true)发现每个 scope 下可用的 facet_key。
  • facet_key 必须是所请求 scope 下的分面字段(is_facet: true),且 show_type 为 list、value_type 不是数组类型,否则返回 InvalidParameter。
  • facet_key 为 null 的事件不参与统计。传入 facet_value 时只统计取值等于它的事件,其 JSON 类型须与字段的 value_type 一致。
  • 传入 dql 可在统计前过滤事件。sql 只填 WHERE 条件本身;其中任意位置出现 SELECT(不区分大小写)都会被拒绝。
  • 调用者无权访问的私有应用的事件不参与统计,与 POST /rum/data/query 一致。
  • limit 默认 100,最大 100。
  • start_time / end_time 必填,为 Unix 毫秒时间戳,跨度不超过 31 天。
  • scope 为 sourcemap 时,用 type 和 kind 选择统计哪个符号文件库。

授权

app_key
string
query
必填

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

请求体

application/json

分面值分布统计的请求参数。

end_time
integer<int64>
必填

时间范围结束,Unix 毫秒时间戳。最大跨度 31 天。

示例:

1712707200000

facet_key
string
必填

要统计取值分布的字段 key,如 error_type。必须是所给 scope 下 show_type 为 list、value_type 非数组类型的分面字段。可通过 POST /rum/field/list 查询候选字段。

scope
enum<string>
必填

要查询的 RUM 数据 scope。取值:

可用选项:
session,
view,
action,
error,
resource,
long_task,
vital,
issue,
sourcemap
start_time
integer<int64>
必填

时间范围起始,Unix 毫秒时间戳。

示例:

1712620800000

dql
string

统计前应用的 RUM DQL 过滤表达式,其中的字段会按 scope 校验。过滤条件中的取值列表(field:(a OR b ...))最多包含 100 个值。

facet_value
any

传入时只统计 facet_key 等于该值的事件。JSON 类型须与字段的 value_type 一致(字符串、数字或布尔),不一致返回 InvalidParameter。不传时排除取值为 null 的事件。

kind
enum<string>

符号类型,仅在 scope 为 sourcemap 时使用,且只对 android/harmony 有意义:mapping(默认)选择 ProGuard/R8 mapping 或 ArkTS Sourcemap,native 选择 native .so 符号。

可用选项:
mapping,
native
limit
integer
默认值:100

返回的最大 Top N 值数量。默认 100,最大 100。

必填范围: x <= 100
sql
string

额外的 SQL 过滤条件,只写 WHERE 后面的条件本身(不含 WHERE 关键字),如 env = 'prod'。出现 SELECT 会被拒绝。过滤条件中的取值列表(field IN (...))最多包含 100 个值。

type
enum<string>

符号文件存储的平台,仅在 scope 为 sourcemap 时使用。省略时默认为 browser;web、javascript 是 browser 的别名。

可用选项:
browser,
web,
javascript,
android,
ios,
miniprogram,
harmony,
flutter,
electron,
react-native

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

按计数降序排列的 Top N 分面值。