查询字段列表
curl --request POST \
--url 'https://api.flashcat.cloud/rum/field/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"is_facet": false,
"scopes": [
"error"
]
}
'import requests
url = "https://api.flashcat.cloud/rum/field/list?app_key="
payload = {
"is_facet": False,
"scopes": ["error"]
}
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({is_facet: false, scopes: ['error']})
};
fetch('https://api.flashcat.cloud/rum/field/list?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/field/list?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([
'is_facet' => false,
'scopes' => [
'error'
]
]),
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/field/list?app_key="
payload := strings.NewReader("{\n \"is_facet\": false,\n \"scopes\": [\n \"error\"\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/field/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"is_facet\": false,\n \"scopes\": [\n \"error\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/field/list?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 \"is_facet\": false,\n \"scopes\": [\n \"error\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"account_id": 0,
"description": "The type of the error.",
"edit_able": false,
"enum_values": [],
"field_key": "error.type",
"field_name": "Error type",
"group": "Error",
"is_facet": true,
"queryable": true,
"scopes": [
"error"
],
"show_type": "list",
"status": "active",
"unit_family": "",
"unit_name": "",
"value_type": "string"
}
]
},
"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."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}RUM 自定义字段
查询字段列表
返回 RUM 字段定义,可按 scope 和是否为分面字段过滤。
POST
/
rum
/
field
/
list
查询字段列表
curl --request POST \
--url 'https://api.flashcat.cloud/rum/field/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"is_facet": false,
"scopes": [
"error"
]
}
'import requests
url = "https://api.flashcat.cloud/rum/field/list?app_key="
payload = {
"is_facet": False,
"scopes": ["error"]
}
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({is_facet: false, scopes: ['error']})
};
fetch('https://api.flashcat.cloud/rum/field/list?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/field/list?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([
'is_facet' => false,
'scopes' => [
'error'
]
]),
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/field/list?app_key="
payload := strings.NewReader("{\n \"is_facet\": false,\n \"scopes\": [\n \"error\"\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/field/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"is_facet\": false,\n \"scopes\": [\n \"error\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/field/list?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 \"is_facet\": false,\n \"scopes\": [\n \"error\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"account_id": 0,
"description": "The type of the error.",
"edit_able": false,
"enum_values": [],
"field_key": "error.type",
"field_name": "Error type",
"group": "Error",
"is_facet": true,
"queryable": true,
"scopes": [
"error"
],
"show_type": "list",
"status": "active",
"unit_family": "",
"unit_name": "",
"value_type": "string"
}
]
},
"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."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}限制说明
| 项目 | 说明 |
|---|---|
| 速率限制 | 每个账户 1,000 次/分钟;50 次/秒 |
| 权限要求 | 无 —— 持有有效的 app_key 即可调用 |
使用说明
- 这是当前字段模型下用于发现 RUM 字段的路由。
- 返回的
field_key可用于 RUM 数据查询和分面值统计请求。 - 设置
is_facet: true只返回支持值分布统计的字段。
授权
在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。
请求体
application/json
RUM 字段定义列表的过滤参数。
不传或为 null 时返回所有字段;为 true 时只返回支持分面查询的字段;为 false 时只返回不支持分面查询的字段。
按 RUM 数据 scope 过滤;传入未知值会被参数校验拒绝。不传则返回所有 scope 的字段。
| 值 | 含义 |
|---|---|
session | 用户会话 |
view | 页面/视图 |
action | 用户操作 |
error | 错误事件 |
resource | 资源加载 |
long_task | 长任务 |
vital | 性能指标(Web Vitals 等) |
issue | 异常聚合 Issue |
sourcemap | Sourcemap 符号文件 |
可用选项:
session, view, action, error, resource, long_task, vital, issue, sourcemap 此页面对您有帮助吗?