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

client.rum.siteInfo.list(SiteInfoListParams { account_id, order_by, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<Site { auto_install, created, rules, 4 more } >

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

Get a Web Analytics site

client.rum.siteInfo.get(stringsiteId, SiteInfoGetParams { account_id } params, RequestOptionsoptions?): Site { auto_install, created, rules, 4 more }

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

Create a Web Analytics site

client.rum.siteInfo.create(SiteInfoCreateParams { account_id, auto_install, host, zone_tag } params, RequestOptionsoptions?): Site { auto_install, created, rules, 4 more }

POST/accounts/{account_id}/rum/site_info

Update a Web Analytics site

client.rum.siteInfo.update(stringsiteId, SiteInfoUpdateParams { account_id, auto_install, enabled, 3 more } params, RequestOptionsoptions?): Site { auto_install, created, rules, 4 more }

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

Delete a Web Analytics site

client.rum.siteInfo.delete(stringsiteId, SiteInfoDeleteParams { account_id } params, RequestOptionsoptions?): SiteInfoDeleteResponse { site_tag }

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

ModelsExpand Collapse

Site { auto_install, created, rules, 4 more }

auto_install?: boolean

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

created?: string

formatdate-time

rules?: Array<RUMRule { id, created, host, 4 more } >

A list of rules.

id?: string

The Web Analytics rule identifier.

created?: string

formatdate-time

host?: string

The hostname the rule will be applied to.

inclusive?: boolean

Whether the rule includes or excludes traffic from being measured.

is_paused?: boolean

Whether the rule is paused or not.

paths?: Array<string>

The paths the rule will be applied to.

priority?: number

ruleset?: Ruleset { id, enabled, zone_name, zone_tag }

id?: string

The Web Analytics ruleset identifier.

enabled?: boolean

Whether the ruleset is enabled.

zone_name?: string

zone_tag?: string

The zone identifier.

site_tag?: string

The Web Analytics site identifier.

site_token?: string

The Web Analytics site token.

snippet?: string

Encoded JavaScript snippet.

SiteInfoDeleteResponse { site_tag }

site_tag?: string

The Web Analytics site identifier.

RUMRules

List rules in Web Analytics ruleset

client.rum.rules.list(stringrulesetId, RuleListParams { account_id } params, RequestOptionsoptions?): RuleListResponse { rules, ruleset }

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

Create a Web Analytics rule

client.rum.rules.create(stringrulesetId, RuleCreateParams { account_id, host, inclusive, 2 more } params, RequestOptionsoptions?): RUMRule { id, created, host, 4 more }

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

Update a Web Analytics rule

client.rum.rules.update(stringrulesetId, stringruleId, RuleUpdateParams { account_id, host, inclusive, 2 more } params, RequestOptionsoptions?): RUMRule { id, created, host, 4 more }

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

Delete a Web Analytics rule

client.rum.rules.delete(stringrulesetId, stringruleId, RuleDeleteParams { account_id } params, RequestOptionsoptions?): RuleDeleteResponse { id }

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

Update Web Analytics rules

client.rum.rules.bulkCreate(stringrulesetId, RuleBulkCreateParams { account_id, delete_rules, rules } params, RequestOptionsoptions?): RuleBulkCreateResponse { rules, ruleset }

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

ModelsExpand Collapse

RUMRule { id, created, host, 4 more }

id?: string

The Web Analytics rule identifier.

created?: string

formatdate-time

host?: string

The hostname the rule will be applied to.

inclusive?: boolean

Whether the rule includes or excludes traffic from being measured.

is_paused?: boolean

Whether the rule is paused or not.

paths?: Array<string>

The paths the rule will be applied to.

priority?: number

RuleListResponse { rules, ruleset }

rules?: Array<RUMRule { id, created, host, 4 more } >

A list of rules.

id?: string

The Web Analytics rule identifier.

created?: string

formatdate-time

host?: string

The hostname the rule will be applied to.

inclusive?: boolean

Whether the rule includes or excludes traffic from being measured.

is_paused?: boolean

Whether the rule is paused or not.

paths?: Array<string>

The paths the rule will be applied to.

priority?: number

ruleset?: Ruleset { id, enabled, zone_name, zone_tag }

id?: string

The Web Analytics ruleset identifier.

enabled?: boolean

Whether the ruleset is enabled.

zone_name?: string

zone_tag?: string

The zone identifier.

RuleDeleteResponse { id }

id?: string

The Web Analytics rule identifier.

RuleBulkCreateResponse { rules, ruleset }

rules?: Array<RUMRule { id, created, host, 4 more } >

A list of rules.

id?: string

The Web Analytics rule identifier.

created?: string

formatdate-time

host?: string

The hostname the rule will be applied to.

inclusive?: boolean

Whether the rule includes or excludes traffic from being measured.

is_paused?: boolean

Whether the rule is paused or not.

paths?: Array<string>

The paths the rule will be applied to.

priority?: number

ruleset?: Ruleset { id, enabled, zone_name, zone_tag }

id?: string

The Web Analytics ruleset identifier.

enabled?: boolean

Whether the ruleset is enabled.

zone_name?: string

zone_tag?: string

The zone identifier.