API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

RUM

RUMSite Info

List Web Analytics sites

rum.site_info.list(SiteInfoListParams**kwargs) -> SyncV4PagePaginationArray[Site]

GET/accounts/{account_id}/rum/site_info/list

Get a Web Analytics site

rum.site_info.get(strsite_id, SiteInfoGetParams**kwargs) -> Site

GET/accounts/{account_id}/rum/site_info/{site_id}

Create a Web Analytics site

rum.site_info.create(SiteInfoCreateParams**kwargs) -> Site

POST/accounts/{account_id}/rum/site_info

Update a Web Analytics site

rum.site_info.update(strsite_id, SiteInfoUpdateParams**kwargs) -> Site

PUT/accounts/{account_id}/rum/site_info/{site_id}

Delete a Web Analytics site

rum.site_info.delete(strsite_id, SiteInfoDeleteParams**kwargs) -> SiteInfoDeleteResponse

DELETE/accounts/{account_id}/rum/site_info/{site_id}

ModelsExpand Collapse

class Site: …

auto_install: Optional[bool]

If enabled, the JavaScript snippet is automatically injected for orange-clouded sites.

created: Optional[datetime]

formatdate-time

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.

site_tag: Optional[str]

The Web Analytics site identifier.

site_token: Optional[str]

The Web Analytics site token.

snippet: Optional[str]

Encoded JavaScript snippet.

class SiteInfoDeleteResponse: …

site_tag: Optional[str]

The Web Analytics site identifier.

RUMRules

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.