{"type":"api","title":"Get Alarm Severity Custom Histogram","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 alarm severity histogram","operationId":"getAlarmSeverityCustomHistogram","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Get alarms filter by severity":{"description":"Get alarms filter by severity","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"severity","operator":"in","type":"string","value":["Critical"]}]},"size":100},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity"},"Get alarms filter by site-id":{"description":"Get alarms filter by site-id","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"site_id","operator":"in","type":"string","value":["400","500"]}]},"size":100},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites"},"Get active alarms":{"description":"Get active alarms","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"active","type":"boolean","value":["true"],"operator":"equal"}]}},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive"},"Get alarms filter by type":{"description":"Get alarms filter by type","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"rule_name_display","operator":"in","type":"string","value":["Memory_Usage"]}]},"size":10000},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType"},"Get alarms filter by hours":{"description":"Get alarms filter by hours","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]}]},"size":100},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours"},"Get alarms filter by system ip":{"description":"Get alarms filter by system ip","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"system_ip","operator":"in","type":"string","value":["1.1.1.1"]}]},"size":100},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp"},"Get alarms filter between dates":{"description":"Get alarms filter between dates","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","type":"date","value":["2024-04-30T19:30:00 UTC","2024-05-30T17:30:00 UTC"],"operator":"between"}]},"size":10000},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates"}}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","$$ref":"#/components/schemas/SeveritySummary"},"examples":{"Severity":{"description":"Severity","value":{"header":{"generatedOn":1718005537956,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-Alarm_histogram"},"columns":[{"title":"Event Time","property":"entry_time","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","width":200,"dataType":"date"},{"title":"Count","property":"count","width":150,"dataType":"number"},{"title":"Component","property":"component","width":150,"dataType":"string"}],"fields":[{"property":"entry_time","dataType":"date"},{"property":"count","dataType":"number"},{"property":"component","dataType":"string"}],"chart":{"xAxis":["entry_time"],"yAxis":["count"],"series":["component"],"title":"view.chart.clientViewAlarmHistogram.alarm","xAxisLabel":"view.chart.clientViewAlarmHistogram.time","yAxisLabel":"view.chart.clientViewAlarmHistogram.count"}},"data":[{"entry_time":1717966800000,"component":"","count":0},{"entry_time":1717970400000,"component":"","count":0},{"entry_time":1717974000000,"component":"","count":0},{"entry_time":1717977600000,"component":"","count":0},{"entry_time":1717981200000,"component":"","count":0},{"entry_time":1717984800000,"component":"","count":0},{"entry_time":1717988400000,"component":"Critical","count":19},{"entry_time":1717988400000,"component":"Major","count":2},{"entry_time":1717988400000,"component":"Minor","count":40},{"entry_time":1717988400000,"component":"Medium","count":17},{"entry_time":1717992000000,"component":"Minor","count":141},{"entry_time":1717992000000,"component":"Medium","count":130},{"entry_time":1717992000000,"component":"Major","count":1},{"entry_time":1717995600000,"component":"Major","count":1},{"entry_time":1717995600000,"component":"Minor","count":148},{"entry_time":1717995600000,"component":"Medium","count":149},{"entry_time":1717999200000,"component":"Minor","count":76},{"entry_time":1717999200000,"component":"Medium","count":76},{"entry_time":1718002800000,"component":"Major","count":1},{"entry_time":1718002800000,"component":"Medium","count":109},{"entry_time":1718002800000,"component":"Minor","count":108}]},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseSeverity"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Alarms-read","method":"get","path":"/alarms/severity/summary"}}