查询分值分布

按出现次数降序返回指定时间范围内某个分面字段的 Top N 值及其计数。

POST /rum/facet/count

查询分值分布

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/rum/facet/count?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "error",
  "facet_key": "error.type",
  "start_time": 1712620800000,
  "end_time": 1712707200000,
  "limit": 10
}
'

import requests

url = "https://api.flashcat.cloud/rum/facet/count?app_key="

payload = {
    "scope": "error",
    "facet_key": "error.type",
    "start_time": 1712620800000,
    "end_time": 1712707200000,
    "limit": 10
}
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({
    scope: 'error',
    facet_key: 'error.type',
    start_time: 1712620800000,
    end_time: 1712707200000,
    limit: 10
  })
};

fetch('https://api.flashcat.cloud/rum/facet/count?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/facet/count?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([
    'scope' => 'error',
    'facet_key' => 'error.type',
    'start_time' => 1712620800000,
    'end_time' => 1712707200000,
    'limit' => 10
  ]),
  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/facet/count?app_key="

	payload := strings.NewReader("{\n  \"scope\": \"error\",\n  \"facet_key\": \"error.type\",\n  \"start_time\": 1712620800000,\n  \"end_time\": 1712707200000,\n  \"limit\": 10\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/facet/count?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": \"error\",\n  \"facet_key\": \"error.type\",\n  \"start_time\": 1712620800000,\n  \"end_time\": 1712707200000,\n  \"limit\": 10\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/rum/facet/count?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  \"scope\": \"error\",\n  \"facet_key\": \"error.type\",\n  \"start_time\": 1712620800000,\n  \"end_time\": 1712707200000,\n  \"limit\": 10\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "facet_value": "TypeError",
        "count": 1523
      },
      {
        "facet_value": "ReferenceError",
        "count": 342
      },
      {
        "facet_value": "SyntaxError",
        "count": 89
      }
    ]
  }
}

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

​

限制说明

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

​

使用说明

• 使用 POST /rum/field/list 发现每个 scope 下可用的 facet_key 值。
• scope 必须是以下之一：session、view、action、error、resource、long_task、vital、issue、sourcemap。
• 传入 dql 可在统计前进一步过滤事件，DQL 语法遵循 RUM 查询语言。
• 传入 sql 可使用仅含 WHERE 子句（无 SELECT）的 SQL 风格过滤。
• 默认 limit 为 100，最大 100。
• 时间范围必填（start_time / end_time 为 Unix 毫秒时间戳），最大跨度 31 天。

授权

app_key · string · query · 必填

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

请求体

application/json

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

scope · enum<string> · 必填

要查询的 RUM 数据 scope。

可用选项: session, view, action, error, resource, long_task, vital, issue, sourcemap

facet_key · string · 必填

要统计值分布的字段键。

start_time · integer<int64> · 必填

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

示例:

1712620800000

end_time · integer<int64> · 必填

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

示例:

1712707200000

facet_value · any

设置后，统计前会先过滤 facet_key 等于该值的事件。接受字符串、数字或布尔值。

dql · string

统计前应用的 RUM DQL 过滤表达式。

sql · string

仅含 WHERE 子句（无 SELECT）的 SQL 附加过滤条件。

limit · integer · 默认值: 100

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

必填范围: x <= 100

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

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

Show child attributes