Skip to content
Cloudflare API
Start here
API Reference
RUM

Rules

List rules in Web Analytics ruleset
rum.rules.list(strruleset_id, RuleListParams**kwargs) -> RuleListResponse
GET/accounts/{account_id}/rum/v2/{ruleset_id}/rules
Create a Web Analytics rule
rum.rules.create(strruleset_id, RuleCreateParams**kwargs) -> RUMRule
POST/accounts/{account_id}/rum/v2/{ruleset_id}/rule
Update a Web Analytics rule
rum.rules.update(strrule_id, RuleUpdateParams**kwargs) -> RUMRule
PUT/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}
Delete a Web Analytics rule
rum.rules.delete(strrule_id, RuleDeleteParams**kwargs) -> RuleDeleteResponse
DELETE/accounts/{account_id}/rum/v2/{ruleset_id}/rule/{rule_id}
Update Web Analytics rules
rum.rules.bulk_create(strruleset_id, RuleBulkCreateParams**kwargs) -> RuleBulkCreateResponse
POST/accounts/{account_id}/rum/v2/{ruleset_id}/rules
ModelsExpand Collapse
class RUMRule: …
id: Optional[str]

The Web Analytics rule identifier.

created: Optional[datetime]
formatdate-time
host: Optional[str]

The hostname the rule will be applied to.

inclusive: Optional[bool]

Whether the rule includes or excludes traffic from being measured.

is_paused: Optional[bool]

Whether the rule is paused or not.

paths: Optional[List[str]]

The paths the rule will be applied to.

priority: Optional[float]
class RuleListResponse: …
rules: Optional[List[RUMRule]]

A list of rules.

id: Optional[str]

The Web Analytics rule identifier.

created: Optional[datetime]
formatdate-time
host: Optional[str]

The hostname the rule will be applied to.

inclusive: Optional[bool]

Whether the rule includes or excludes traffic from being measured.

is_paused: Optional[bool]

Whether the rule is paused or not.

paths: Optional[List[str]]

The paths the rule will be applied to.

priority: Optional[float]
ruleset: Optional[Ruleset]
id: Optional[str]

The Web Analytics ruleset identifier.

enabled: Optional[bool]

Whether the ruleset is enabled.

zone_name: Optional[str]
zone_tag: Optional[str]

The zone identifier.

class RuleDeleteResponse: …
id: Optional[str]

The Web Analytics rule identifier.

class RuleBulkCreateResponse: …
rules: Optional[List[RUMRule]]

A list of rules.

id: Optional[str]

The Web Analytics rule identifier.

created: Optional[datetime]
formatdate-time
host: Optional[str]

The hostname the rule will be applied to.

inclusive: Optional[bool]

Whether the rule includes or excludes traffic from being measured.

is_paused: Optional[bool]

Whether the rule is paused or not.

paths: Optional[List[str]]

The paths the rule will be applied to.

priority: Optional[float]
ruleset: Optional[Ruleset]
id: Optional[str]

The Web Analytics ruleset identifier.

enabled: Optional[bool]

Whether the ruleset is enabled.

zone_name: Optional[str]
zone_tag: Optional[str]

The zone identifier.