{"type":"api","title":"sitehealth data","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/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 - 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"]}}],"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"}},"__originalOperationId":"getSiteHealth","method":"get","path":"/statistics/sitehealth/common"}}