查询字段列表

返回 RUM 字段定义，可按 scope 和是否为分面字段过滤。

POST /rum/field/list

查询字段列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/rum/field/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopes": [
    "error"
  ],
  "is_facet": false
}
'

import requests

url = "https://api.flashcat.cloud/rum/field/list?app_key="

payload = {
    "scopes": ["error"],
    "is_facet": False
}
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({scopes: ['error'], is_facet: false})
};

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([
    'scopes' => [
        'error'
    ],
    'is_facet' => false
  ]),
  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  \"scopes\": [\n    \"error\"\n  ],\n  \"is_facet\": false\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  \"scopes\": [\n    \"error\"\n  ],\n  \"is_facet\": false\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  \"scopes\": [\n    \"error\"\n  ],\n  \"is_facet\": false\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "account_id": 0,
        "field_key": "error.type",
        "field_name": "Error type",
        "group": "Error",
        "description": "错误类型。",
        "value_type": "string",
        "show_type": "list",
        "unit_family": "",
        "unit_name": "",
        "edit_able": false,
        "is_facet": true,
        "enum_values": [],
        "scopes": [
          "error"
        ],
        "status": "active",
        "queryable": true
      }
    ]
  }
}

{
  "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 即可调用

​

使用说明

• 这是当前字段模型下用于发现 RUM 字段的路由。
• 返回的 field_key 可用于 RUM 数据查询和分面值统计请求。
• 设置 is_facet: true 只返回支持值分布统计的字段。

授权

app_key · string · query · 必填

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

请求体

application/json

RUM 字段定义列表的过滤参数。

scopes · string[]

按 RUM 数据 scope 过滤。合法值：session、view、action、error、resource、long_task、vital、issue、sourcemap。

is_facet · boolean

为 true 时只返回支持分面查询的字段；为 false 或不传时返回所有字段。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

RUM 字段定义列表。

Show child attributes