Skip to main content
POST
/
rum
/
facet
/
list
List RUM facet fields
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": "The type of the error.",
        "value_type": "string",
        "show_type": "list",
        "unit_family": "",
        "unit_name": "",
        "edit_able": false,
        "is_facet": true,
        "enum_values": [],
        "scopes": [
          "error"
        ],
        "status": "active",
        "queryable": true
      }
    ]
  }
}

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsNone — any valid app_key can call this operation

​
Usage

  • Use the returned field_key values as facet_key in POST /rum/facet/count.
  • Valid scopes are: session, view, action, error, resource, long_task, vital, issue, sourcemap.
  • Set is_facet: true to return only facet-enabled fields (those that support value distribution queries).

Authorizations

​
app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Filter parameters for listing RUM field definitions.

​
scopes
string[]

Filter by RUM data scopes. Valid values: session, view, action, error, resource, long_task, vital, issue, sourcemap.

​
is_facet
boolean

When true, return only facet-enabled fields. When false or omitted, return all fields.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
required

List of RUM field definitions.