Modifies one or more rules in a Web Analytics ruleset with a single request.
/accounts/{account_identifier}/rum/v2/{ruleset_identifier}/rules
post
Web Analytics
web-analytics-modify-rules
{
"business": true,
"enterprise": true,
"free": false,
"pro": true
}null[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "ruleset_identifier",
"required": true,
"schema": {
"description": "The Web Analytics ruleset identifier.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"delete_rules": {
"description": "A list of rule identifiers to delete.",
"items": {
"description": "The Web Analytics rule identifier.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"type": "string"
},
"type": "array"
},
"rules": {
"description": "A list of rules to create or update.",
"items": {
"properties": {
"host": {
"example": "example.com",
"type": "string"
},
"id": {
"description": "The Web Analytics rule identifier.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"type": "string"
},
"inclusive": {
"example": true,
"type": "boolean"
},
"is_paused": {
"example": false,
"type": "boolean"
},
"paths": {
"example": [
"*"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"success": {
"description": "Whether the API call was successful.",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages"
],
"type": "object"
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"rules": {
"description": "A list of rules.",
"items": {
"properties": {
"created": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"host": {
"description": "The hostname the rule will be applied to.",
"example": "example.com",
"type": "string"
},
"id": {
"description": "The Web Analytics rule identifier.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"type": "string"
},
"inclusive": {
"description": "Whether the rule includes or excludes traffic from being measured.",
"example": true,
"type": "boolean"
},
"is_paused": {
"description": "Whether the rule is paused or not.",
"example": false,
"type": "boolean"
},
"paths": {
"description": "The paths the rule will be applied to.",
"example": [
"*"
],
"items": {
"type": "string"
},
"type": "array"
},
"priority": {
"example": 1000,
"type": "number"
}
},
"type": "object"
},
"type": "array"
},
"ruleset": {
"properties": {
"enabled": {
"description": "Whether the ruleset is enabled.",
"example": true,
"type": "boolean"
},
"id": {
"description": "The Web Analytics ruleset identifier.",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"type": "string"
},
"zone_name": {
"example": "example.com",
"type": "string"
},
"zone_tag": {
"description": "The zone identifier.",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "List of modified Web Analytics rules"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "Failure response"
}
}[
{
"api_email": [],
"api_key": []
}
]