---
title: Create a Web Analytics rule
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[RUM](https://developers.cloudflare.com/api/resources/rum)
[Rules](https://developers.cloudflare.com/api/resources/rum/subresources/rules)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Create a Web Analytics rule
POST/accounts/{account\_id}/rum/v2/{ruleset\_id}/rule
Creates a new rule in a Web Analytics ruleset.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### P ath ParametersExpand Collapse
account\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
ruleset\_id: string
The Web Analytics ruleset identifier.
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20ruleset_id%20%3E%20(schema)>)
##### Body ParametersJSONExpand Collapse
host: optional string
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20host%20%3E%20(schema)>)
inclusive: optional boolean
Whether the rule includes or excludes traffic from being measured.
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20inclusive%20%3E%20(schema)>)
is\_paused: optional boolean
Whether the rule is paused or not.
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20is_paused%20%3E%20(schema)>)
paths: optional array of string
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20paths%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: boolean
Whether the API call was successful.
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional RUMRule { id, created, host, 4 more }
id: optional string
The Web Analytics rule identifier.
Link to this property
created: optional string
formatdate-time
Link to this property
host: optional string
The hostname the rule will be applied to.
Link to this property
inclusive: optional boolean
Whether the rule includes or excludes traffic from being measured.
Link to this property
is\_paused: optional boolean
Whether the rule is paused or not.
Link to this property
paths: optional array of string
The paths the rule will be applied to.
Link to this property
priority: optional number
Link to this property
[Link to this property](<#(resource)%20rum.rules%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Create a Web Analytics rule
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/rum/v2/$RULESET_ID/rule \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{
"host": "example.com",
"inclusive": true,
"paths": [
"*"
]
}'
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created": "2014-01-01T05:20:00.12345Z",
"host": "example.com",
"inclusive": true,
"is_paused": false,
"paths": [
"*"
],
"priority": 1000
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": {
"id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"created": "2014-01-01T05:20:00.12345Z",
"host": "example.com",
"inclusive": true,
"is_paused": false,
"paths": [
"*"
],
"priority": 1000
}
}
```