查询 RUM 数据

在指定时间范围内执行一个或多个 SQL 风格的 RUM 数据查询。

POST /rum/data/query

查询 RUM 数据

cURL

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"
    }
  ]
}
'

import requests

url = "https://api.flashcat.cloud/rum/data/query?app_key="

payload = {
    "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"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
      }
    ]
  })
};

fetch('https://api.flashcat.cloud/rum/data/query?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/rum/data/query?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/rum/data/query?app_key="

	payload := strings.NewReader("{\n  \"start_time\": 1712620800000,\n  \"end_time\": 1712707200000,\n  \"queries\": [\n    {\n      \"id\": \"errors_by_type\",\n      \"sql\": \"SELECT error.type, count(*) AS errors FROM error GROUP BY error.type ORDER BY errors DESC LIMIT 10\",\n      \"format\": \"table\",\n      \"time_zone\": \"Asia/Shanghai\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/rum/data/query?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"start_time\": 1712620800000,\n  \"end_time\": 1712707200000,\n  \"queries\": [\n    {\n      \"id\": \"errors_by_type\",\n      \"sql\": \"SELECT error.type, count(*) AS errors FROM error GROUP BY error.type ORDER BY errors DESC LIMIT 10\",\n      \"format\": \"table\",\n      \"time_zone\": \"Asia/Shanghai\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/rum/data/query?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"start_time\": 1712620800000,\n  \"end_time\": 1712707200000,\n  \"queries\": [\n    {\n      \"id\": \"errors_by_type\",\n      \"sql\": \"SELECT error.type, count(*) AS errors FROM error GROUP BY error.type ORDER BY errors DESC LIMIT 10\",\n      \"format\": \"table\",\n      \"time_zone\": \"Asia/Shanghai\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "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
          ]
        ]
      }
    }
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

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

​

使用说明

• 单次请求可提交 1 到 10 个查询；每个查询的 id 会成为响应对象中的 key。
• start_time 和 end_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

Show child attributes

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

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

Show child attributes