跳转到主要内容
POST
/
rum
/
data
/
query
查询 RUM 数据
curl --request POST \
  --url 'https://api.flashcat.cloud/rum/data/query?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1712620800000,
  "end_time": 1712707200000,
  "queries": [
    {
      "id": "errors_by_type",
      "sql": "SELECT error.type, count(*) AS errors FROM error GROUP BY error.type ORDER BY errors DESC LIMIT 10",
      "format": "table",
      "time_zone": "Asia/Shanghai"
    }
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "errors_by_type": {
      "data": {
        "fields": [
          {
            "name": "error.type",
            "type": "String",
            "nullable": false
          },
          {
            "name": "errors",
            "type": "UInt64",
            "nullable": false
          }
        ],
        "values": [
          [
            "TypeError",
            1523
          ],
          [
            "ReferenceError",
            342
          ]
        ]
      }
    }
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

使用说明

  • 单次请求可提交 1 到 10 个查询;每个查询的 id 会成为响应对象中的 key。
  • start_timeend_time 必填,均为 Unix 毫秒时间戳;最大时间范围为 31 天。
  • 使用 format: table 返回表格结果,使用 format: time_series 返回按时间桶聚合的时序结果。
  • format: time_series 时,省略 interval 会默认使用 3600 秒,省略 max_points 会默认使用 1226。
  • 分页表格查询会返回 search_after_ctx,继续扫描时可原样传回。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

指定时间范围内的一组 RUM 数据查询。

start_time
integer<int64>
必填

查询窗口起始时间,Unix 毫秒时间戳。

示例:

1712620800000

end_time
integer<int64>
必填

查询窗口结束时间,Unix 毫秒时间戳。最大跨度 31 天。

示例:

1712707200000

queries
object[]
必填

并发执行的查询列表,允许 1 到 10 个。

Required array length: 1 - 10 elements

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

从请求中的查询 ID 到该查询结果或错误的映射。