{"type":"api","title":"sitehealth data","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 - SiteHealth Monitor"],"summary":"sitehealth data","description":"Get all site health ","operationId":"getSiteHealth","parameters":[{"name":"isHeatMap","in":"query","schema":{"type":"string","default":"false"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"interval","in":"query","schema":{"type":"integer","format":"int32","default":30}},{"name":"health","in":"query","schema":{"type":"string","enum":["GOOD","FAIR","POOR"]}},{"name":"start_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"end_time","in":"query","schema":{"type":"integer","format":"int64"}},{"name":"includeDetails","in":"query","schema":{"type":"string","default":"false"}},{"name":"includeRegion","in":"query","schema":{"type":"string","default":"false"}},{"name":"regionName","in":"query","schema":{"type":"string"}},{"name":"deviceType","in":"query","schema":{"type":"string","enum":["controller","vedge","all"]}},{"name":"sortBy","in":"query","description":"To sort results by given field.device_count: To sort by device_count, includeDetails needs to be true.","schema":{"type":"string","example":"device_count"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"required":["apps_health","apps_usage","devices_health","site_health","site_id","tunnels_health"],"type":"object","properties":{"apps_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"apps_usage":{"type":"number","example":1000},"devices_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"site_health":{"type":"string","example":"good","enum":["good","fair","poor"]},"site_id":{"type":"string","example":"600"},"tunnels_health":{"type":"string","example":"good","enum":["good","fair","poor"]}},"$$ref":"#/components/schemas/SiteHealthItem"}}}}},"400":{"description":"bad input parameter"}},"method":"get","path":"/statistics/sitehealth/common"}}