{"type":"api","title":"Tunnel health overview 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 - Tunnel Health"],"summary":"Tunnel health overview data","description":"Get all tunnel health overview ","operationId":"statisticsApprouteTunnelhealthOverviewTypeGet","parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string"}},{"name":"last_n_hours","in":"query","schema":{"type":"integer","format":"int32","default":12}},{"name":"site","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":30}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"object","properties":{"fair":{"type":"array","items":{"type":"object","properties":{"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double"},"jitter":{"type":"number","format":"double"},"latency":{"type":"number","format":"double"},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.21"},"loss_percentage":{"type":"number","format":"double"},"name":{"type":"string","example":"vm11:lte-vm6:lte"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.16"},"rx_octets":{"type":"number"},"state":{"type":"string","enum":["Up","Down"]},"tx_octets":{"type":"number"},"vqoe_score":{"type":"number","format":"double"}},"$$ref":"#/components/schemas/TunnelHealthOverviewEntry"}},"good":{"type":"array","items":{"type":"object","properties":{"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double"},"jitter":{"type":"number","format":"double"},"latency":{"type":"number","format":"double"},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.21"},"loss_percentage":{"type":"number","format":"double"},"name":{"type":"string","example":"vm11:lte-vm6:lte"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.16"},"rx_octets":{"type":"number"},"state":{"type":"string","enum":["Up","Down"]},"tx_octets":{"type":"number"},"vqoe_score":{"type":"number","format":"double"}},"$$ref":"#/components/schemas/TunnelHealthOverviewEntry"}},"poor":{"type":"array","items":{"type":"object","properties":{"health":{"type":"string","example":"good","enum":["good","fair","poor","n/a"]},"health_score":{"type":"number","format":"double"},"jitter":{"type":"number","format":"double"},"latency":{"type":"number","format":"double"},"local_color":{"type":"string","example":"lte"},"local_system_ip":{"type":"string","example":"172.16.255.21"},"loss_percentage":{"type":"number","format":"double"},"name":{"type":"string","example":"vm11:lte-vm6:lte"},"remote_color":{"type":"string","example":"lte"},"remote_system_ip":{"type":"string","example":"172.16.255.16"},"rx_octets":{"type":"number"},"state":{"type":"string","enum":["Up","Down"]},"tx_octets":{"type":"number"},"vqoe_score":{"type":"number","format":"double"}},"$$ref":"#/components/schemas/TunnelHealthOverviewEntry"}}},"$$ref":"#/components/schemas/TunnelHealthOverviewDetail"},"total":{"type":"object","properties":{"fair":{"type":"number","example":100},"good":{"type":"number","example":100},"poor":{"type":"number","example":100}},"$$ref":"#/components/schemas/TunnelHealthOverviewTotal"}},"$$ref":"#/components/schemas/TunnelHealthOverview"}}}},"400":{"description":"bad input parameter"}},"__originalOperationId":"statisticsApprouteTunnelhealthOverviewTypeGet","method":"get","path":"/statistics/tunnelhealth/overview/{type}"}}