Skip to main content
POST
List RUM fields

Restrictions

Usage

  • This is the current field-model route for discovering RUM fields.
  • Use returned field_key values in RUM data queries and facet-count requests.
  • Set is_facet: true to return only fields 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.