v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Alerts

Get alerts classification

This API endpoint retrieves the classification of alerts based on the specified type. The classification provides aggregated counts of alerts grouped by the specified criteria.

get/network-notifications/v1/alerts/classification

Query parameters

typestring required

Example:category

The type of classification to retrieve. This determines how alerts are grouped. Possible values are severity, status, priority, category, device_type, impacted_devices

filterstring

Example:siteId eq '1234567'

OData Version 4.0 filter string to filter the alerts before classification.

searchstring

Example:PoE

Search string to filter alerts by name or summary before classification.

Response

Classification of alerts grouped by the specified type.

typestring

The type of classification used.

Example response

{
  "type": "category",
  "classificationData": [
    {
      "name": "System",
      "count": 25,
      "typeId": "102"
    }
  ]
}