API Reference

RUM

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rules

List rules in Web Analytics ruleset

GET/accounts/{account_id}/rum/v2/{ruleset_id}/rules

Create a Web Analytics rule

POST/accounts/{account_id}/rum/v2/{ruleset_id}/rule

Update a Web Analytics rule

PUT/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}

Delete a Web Analytics rule

DELETE/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}

Update Web Analytics rules

POST/accounts/{account_id}/rum/v2/{ruleset_id}/rules

ModelsExpand Collapse

RUMRule { id, created, host, 4 more }

id: optional string

The Web Analytics rule identifier.

created: optional string

formatdate-time

host: optional string

The hostname the rule will be applied to.

inclusive: optional boolean

Whether the rule includes or excludes traffic from being measured.

is_paused: optional boolean

Whether the rule is paused or not.

paths: optional array of string

The paths the rule will be applied to.

priority: optional number

RuleListResponse { rules, ruleset }

rules: optional array of RUMRule { id, created, host, 4 more }

A list of rules.

id: optional string

The Web Analytics rule identifier.

created: optional string

formatdate-time

host: optional string

The hostname the rule will be applied to.

inclusive: optional boolean

Whether the rule includes or excludes traffic from being measured.

is_paused: optional boolean

Whether the rule is paused or not.

paths: optional array of string

The paths the rule will be applied to.

priority: optional number

ruleset: optional { id, enabled, zone_name, zone_tag }

id: optional string

The Web Analytics ruleset identifier.

enabled: optional boolean

Whether the ruleset is enabled.

zone_name: optional string

zone_tag: optional string

The zone identifier.

RuleDeleteResponse { id }

id: optional string

The Web Analytics rule identifier.

RuleBulkCreateResponse { rules, ruleset }

rules: optional array of RUMRule { id, created, host, 4 more }

A list of rules.

id: optional string

The Web Analytics rule identifier.

created: optional string

formatdate-time

host: optional string

The hostname the rule will be applied to.

inclusive: optional boolean

Whether the rule includes or excludes traffic from being measured.

is_paused: optional boolean

Whether the rule is paused or not.

paths: optional array of string

The paths the rule will be applied to.

priority: optional number

ruleset: optional { id, enabled, zone_name, zone_tag }

id: optional string

The Web Analytics ruleset identifier.

enabled: optional boolean

Whether the ruleset is enabled.

zone_name: optional string

zone_tag: optional string

The zone identifier.