{"type":"api","title":"Get Doc Count Monitoring Alarms Details 1603","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 the count of alarms as per the query passed.","operationId":"getDocCount_MonitoringAlarmsDetails_1603","parameters":[{"name":"query","in":"query","description":"Query","required":true,"schema":{"type":"string"},"examples":{"Get active alarms count":{"description":"Get active alarms count","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 count filter by severity":{"description":"Get alarms count 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 count filter by system ip":{"description":"Get alarms count 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 count filter between dates":{"description":"Get alarms count 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"},"Get alarms count filter by type":{"description":"Get alarms count 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 count filter by site-id":{"description":"Get alarms count 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 alarms count filter by hours":{"description":"Get alarms count 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"}}},{"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"},"examples":{"Count":{"description":"Count","value":{"count":17193},"$$ref":"#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseDoccount"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"get","path":"/alarms/doccount"}}