Post Aggregation Data Monitoring Alarms Details 1904 - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Post Aggregation Data Monitoring Alarms Details 1904","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Alarms Details"],"description":"Get aggregated count of alarms based on given query.","operationId":"postAggregationData_MonitoringAlarmsDetails_1904","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}},{"name":"includeTenants","in":"query","description":"Specify whether the tenant alarms need to be visible or not from provider view.","schema":{"type":"boolean"}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","type":"date","value":["24"],"operator":"last_n_hours"}]},"aggregation":{"field":[{"property":"severity","order":"asc","sequence":1}],"histogram":{"property":"entry_time","type":"minute","interval":30,"order":"asc"}}},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestAggregationBySeverity"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"count":{"type":"integer","format":"int64","example":6},"entry_time":{"type":"integer","format":"int64","example":1653575400000},"severity":{"type":"string","enum":["MINOR","MAJOR","MEDIUM","CRITICAL"]}},"$$ref":"#/components/schemas/AlarmAggregation"},"entryTimeList":{"type":"array","items":{"type":"integer","format":"int64"}}},"$$ref":"#/components/schemas/AlarmAggregationResponse"},"examples":{"Aggregation by severity":{"description":"Aggregation by severity","value":{"header":{"generatedOn":1717656395296,"columns":[{"property":"severity","title":"Severity","dataType":"string","isDisplay":true},{"property":"entry_time","title":"Entry_time","dataType":"date","isDisplay":true}],"fields":[{"property":"severity","dataType":"string"},{"property":"entry_time","dataType":"date"}]},"entryTimeList":[1717569000000,1717570800000,1717572600000,1717574400000,1717576200000,1717578000000,1717579800000,1717581600000,1717583400000,1717585200000,1717587000000,1717588800000,1717590600000,1717592400000,1717594200000,1717596000000,1717597800000,1717599600000,1717601400000,1717603200000,1717605000000,1717606800000,1717608600000,1717610400000,1717612200000,1717614000000,1717615800000,1717617600000,1717619400000,1717621200000,1717623000000,1717624800000,1717626600000,1717628400000,1717630200000,1717632000000,1717633800000,1717635600000,1717637400000,1717639200000,1717641000000,1717642800000,1717644600000,1717646400000,1717648200000,1717650000000,1717651800000,1717653600000,1717655400000],"data":[{"entry_time":1717569000000,"severity":"Minor","count":6},{"entry_time":1717569000000,"severity":"Medium","count":7},{"entry_time":1717570800000,"severity":"Minor","count":36},{"entry_time":1717570800000,"severity":"Medium","count":35},{"entry_time":1717572600000,"severity":"Minor","count":59},{"entry_time":1717572600000,"severity":"Medium","count":60},{"entry_time":1717574400000,"severity":"Minor","count":62},{"entry_time":1717574400000,"severity":"Medium","count":62},{"entry_time":1717576200000,"severity":"Medium","count":71},{"entry_time":1717576200000,"severity":"Minor","count":72},{"entry_time":1717578000000,"severity":"Minor","count":66},{"entry_time":1717578000000,"severity":"Medium","count":66},{"entry_time":1717579800000,"severity":"Critical","count":6},{"entry_time":1717579800000,"severity":"Minor","count":60},{"entry_time":1717579800000,"severity":"Major","count":1},{"entry_time":1717579800000,"severity":"Medium","count":62},{"entry_time":1717581600000,"severity":"Critical","count":60},{"entry_time":1717583400000,"severity":"Critical","count":60},{"entry_time":1717585200000,"severity":"Critical","count":60},{"entry_time":1717587000000,"severity":"Critical","count":60},{"entry_time":1717588800000,"severity":"Critical","count":60},{"entry_time":1717590600000,"severity":"Critical","count":60},{"entry_time":1717592400000,"severity":"Critical","count":60},{"entry_time":1717594200000,"severity":"Critical","count":60},{"entry_time":1717596000000,"severity":"Critical","count":60},{"entry_time":1717597800000,"severity":"Critical","count":60},{"entry_time":1717599600000,"severity":"Critical","count":60},{"entry_time":1717601400000,"severity":"Critical","count":60},{"entry_time":1717603200000,"severity":"Critical","count":60},{"entry_time":1717605000000,"severity":"Critical","count":60},{"entry_time":1717606800000,"severity":"Critical","count":60},{"entry_time":1717608600000,"severity":"Critical","count":60},{"entry_time":1717610400000,"severity":"Critical","count":60},{"entry_time":1717612200000,"severity":"Critical","count":60},{"entry_time":1717614000000,"severity":"Critical","count":60},{"entry_time":1717615800000,"severity":"Critical","count":60},{"entry_time":1717617600000,"severity":"Critical","count":60},{"entry_time":1717619400000,"severity":"Critical","count":60},{"entry_time":1717621200000,"severity":"Critical","count":58},{"entry_time":1717623000000,"severity":"Critical","count":60},{"entry_time":1717624800000,"severity":"Critical","count":60},{"entry_time":1717626600000,"severity":"Critical","count":60},{"entry_time":1717628400000,"severity":"Critical","count":60},{"entry_time":1717630200000,"severity":"Critical","count":60},{"entry_time":1717632000000,"severity":"Critical","count":60},{"entry_time":1717633800000,"severity":"Critical","count":60},{"entry_time":1717635600000,"severity":"Critical","count":60},{"entry_time":1717637400000,"severity":"Critical","count":60},{"entry_time":1717639200000,"severity":"Critical","count":60},{"entry_time":1717641000000,"severity":"Critical","count":60},{"entry_time":1717642800000,"severity":"Critical","count":60},{"entry_time":1717644600000,"severity":"Critical","count":60},{"entry_time":1717646400000,"severity":"Critical","count":60},{"entry_time":1717648200000,"severity":"Critical","count":60},{"entry_time":1717650000000,"severity":"Critical","count":60},{"entry_time":1717651800000,"severity":"Critical","count":60},{"entry_time":1717653600000,"severity":"Critical","count":60},{"entry_time":1717655400000,"severity":"Critical","count":34}]},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseAggregationBySeverity"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read","method":"post","path":"/alarms/aggregation"}}