{"type":"api","title":"Post Doc Count","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/bbdb16c27aa20949539a17a086b23efac32312db/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Alarms Details"],"description":"Get the count of alarms as per the query passed.","operationId":"postDocCount","parameters":[{"name":"site-id","in":"query","description":"Specify the site-id to filter the alarms","schema":{"type":"string"}}],"requestBody":{"description":"Query","content":{"application/json":{"schema":{"type":"object"},"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/filter_by_active"},"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/filter_by_hours"},"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/filter_between_dates"},"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/filter_by_type"},"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/filter_by_system_ip"},"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/filter_by_severity"},"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/filter_by_sites"}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Count":{"description":"Count","value":{"count":17193},"$$ref":"#/components/examples/doccount"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"__originalOperationId":"postDocCount","method":"post","path":"/alarms/doccount"}}