"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"type": "string"
}
}
}
}
}
},
"contentAiConfig": {
"index": "example-index-name"
}
},
"createdAt": "2023-12-15T09:30:00Z",
"updatedAt": "2024-01-19T11:20:00Z"
}
]
Retrieve all sites by delivery type
This endpoint is useful for retrieving all sites by delivery type.
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"type": "string"
}
}
}
}
}
},
"contentAiConfig": {
"index": "example-index-name"
}
},
"createdAt": "2023-12-15T09:30:00Z",
"updatedAt": "2024-01-19T11:20:00Z"
}
]
Retrieve a single site by its Base URL
This endpoint is useful for retrieving a site when you only have its Base URL. The Base URL is a unique identifier for a site other than the Site ID.
The base URL provided in the path must be base64 encoded. This is to allow for URLs with special characters to be used as path parameters.
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"type": "string"
}
}
}
}
}
},
"contentAiConfig": {
"index": "example-index-name"
}
},
"createdAt": "2023-12-15T09:30:00Z",
"updatedAt": "2024-01-19T11:20:00Z"
}
Retrieve all sites including their latest audit
This endpoint is useful for retrieving all sites including their latest audit.
@@ -646,7 +646,7 @@
" class="sc-dODueM sc-eHKghg fhLETC jlTrDX">
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"type": "string"
}
}
}
}
}
},
"contentAiConfig": {
"index": "example-index-name"
}
},
"createdAt": "2023-12-15T09:30:00Z",
"updatedAt": "2024-01-19T11:20:00Z"
}
Update a site
This endpoint is useful for updating a site.
@@ -678,7 +678,7 @@
" class="sc-dODueM sc-eHKghg fhLETC jlTrDX">
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"description": "URLs to be excluded from the alert",
"type": "array",
"items": {
"type": "string",
"format": "uri'"
}
},
"groupedURLs": {
"description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the URL group",
"type": "string"
},
"pattern": {
"description": "Pattern representing the URL path structure to group",
"type": "string"
}
}
}
}
}
},
"contentAiConfig": {
"index": "example-index-name"
}
},
"createdAt": "2023-12-15T09:30:00Z",
"updatedAt": "2024-01-19T11:20:00Z"
}
]
Retrieve an organization by IMS Org ID
This endpoint is useful for retrieving an organization by IMS Org ID.