List the recording rules of a RUM application, in evaluation order. Rules combine with ANY.

GET

/rum/{app_id}/rules

const url = 'https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rules';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rules \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

app_id

required

string format: uuid

RUM application identifier

Responses

200

Recording rules

application/json

Array<object>

A recording rule.

object

required

string format: uuid

application_id

required

string format: uuid

name

required

string

capture

required

What a matching session records. Replay implies Analyze.

string

Allowed values: analyze replay

enabled

required

boolean

sample_rate

required

The configured rate, 0.00001 to 1. For an Auto rule, the most Auto may set.

number format: double

auto_sample

required

Auto: the rate follows the replay quota, recomputed hourly (Replay rules only).

boolean

effective_sample_rate

The rate the SDK uses when the sampling tick has set one: the Auto rate, or a lowered rate for an error rule when errored sessions alone would exhaust the replay quota.

number | null format: double

effective_rate_at

string | null format: date-time

conditions

required

All must hold. Empty means every session.

Array

One of:

The page URL, checked on each view. regex values use the common subset of the Rust and JavaScript syntaxes, at most 256 characters, with no nested quantifiers.

object

required

string

Allowed values: contains starts_with regex

value

required

string

kind

required

string

Allowed values: url

A custom event (addAction) with this name.

object

name

required

string

kind

required

string

Allowed values: event

A failed request of this class, optionally to a URL containing url_contains.

object

status_class

required

string

Allowed values: 4xx 5xx network

url_contains

string | null

kind

required

string

Allowed values: network_error

A final vital above gt (milliseconds for LCP and INP, unitless for CLS).

object

metric

required

string

Allowed values: lcp inp cls

required

number format: double

kind

required

string

Allowed values: vital

setUser was called with an id. A struct variant so unknown fields are refused.

object

kind

required

string

Allowed values: identified

A global attribute or user trait equals value.

object

key

required

string

value

required

string

kind

required

string

Allowed values: attribute

min_duration_ms

required

Sampled recordings upload only once the session is this old. Error conditions bypass it.

integer format: int32

require_interaction

required

Sampled recordings upload only after a user interaction. Error conditions bypass it.

boolean

position

required

integer format: int32

created_by_user_id

string | null format: uuid

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

[
  {
    "capture": "analyze",
    "conditions": [
      {
        "op": "contains",
        "kind": "url"
      }
    ]
  }
]

401

Missing or invalid authentication

404

Application not found

500

Internal server error