跳转到主要内容
POST
/
rum
/
facet
/
list
查询分面列表
curl --request POST \
  --url 'https://api.flashcat.cloud/rum/facet/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopes": [
    "error"
  ],
  "is_facet": true
}
'
{
  "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
      }
    ]
  }
}

限制说明

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

使用说明

  • 使用返回的 field_key 作为 POST /rum/facet/countfacet_key 参数。
  • 合法的 scopes 值为:sessionviewactionerrorresourcelong_taskvitalissuesourcemap
  • 设置 is_facet: true 只返回支持分面查询的字段(即支持值分布统计的字段)。

授权

app_key
string
query
必填

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

请求体

application/json

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

scopes
string[]

按 RUM 数据 scope 过滤。合法值:sessionviewactionerrorresourcelong_taskvitalissuesourcemap

is_facet
boolean

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

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

RUM 字段定义列表。