--- title: RUM --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # RUM #### RUMSite Info ##### [List Web Analytics sites](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/site_info/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/site_info/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/site_info/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/site_info/methods/update) 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](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/site_info/methods/delete) 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. Link to this property created?: string formatdate-time Link to this property

rules?: Array<RUMRule {id, created, host, 4 more } > A list of rules.

id?: string The Web Analytics rule identifier. Link to this property created?: string formatdate-time Link to this property host?: string The hostname the rule will be applied to. Link to this property inclusive?: boolean Whether the rule includes or excludes traffic from being measured. Link to this property is\_paused?: boolean Whether the rule is paused or not. Link to this property paths?: Array<string> The paths the rule will be applied to. Link to this property priority?: number Link to this property

Link to this property

ruleset?: Ruleset {id, enabled, zone\_name, zone\_tag }

id?: string The Web Analytics ruleset identifier. Link to this property enabled?: boolean Whether the ruleset is enabled. Link to this property zone\_name?: string Link to this property zone\_tag?: string The zone identifier. Link to this property

Link to this property site\_tag?: string The Web Analytics site identifier. Link to this property site\_token?: string The Web Analytics site token. Link to this property snippet?: string Encoded JavaScript snippet. Link to this property

[Link to this property](<#(resource)%20rum.site_info%20%3E%20(model)%20site%20%3E%20(schema)>)

SiteInfoDeleteResponse {site\_tag }

site\_tag?: string The Web Analytics site identifier. Link to this property

[Link to this property](<#(resource)%20rum.site_info%20%3E%20(model)%20site_info_delete_response%20%3E%20(schema)>) #### RUMRules ##### [List rules in Web Analytics ruleset](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/rules/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/rules/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/rules/methods/update) client.rum.rules.update(stringruleID, RuleUpdateParams {account\_id, ruleset\_id, host, 3 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](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/rules/methods/delete) client.rum.rules.delete(stringruleID, RuleDeleteParams {account\_id, ruleset\_id } params, RequestOptionsoptions?): [RuleDeleteResponse]() {id } DELETE/accounts/{account\_id}/rum/v2/{ruleset\_id}/rule/{rule\_id} ##### [Update Web Analytics rules](https://developers.cloudflare.com/api/typescript/resources/rum/subresources/rules/methods/bulk_create) 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 }

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rum_rule%20%3E%20(schema)>)

RuleListResponse {rules, ruleset }

rules?: Array<RUMRule {id, created, host, 4 more } > A list of rules.

Link to this property

ruleset?: Ruleset {id, enabled, zone\_name, zone\_tag }

Link to this property

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>)

RuleDeleteResponse {id }

id?: string The Web Analytics rule identifier. Link to this property

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rule_delete_response%20%3E%20(schema)>)

RuleBulkCreateResponse {rules, ruleset }

rules?: Array<RUMRule {id, created, host, 4 more } > A list of rules.

Link to this property

ruleset?: Ruleset {id, enabled, zone\_name, zone\_tag }

Link to this property

[Link to this property](<#(resource)%20rum.rules%20%3E%20(model)%20rule_bulk_create_response%20%3E%20(schema)>)