{"type":"api","title":"Get dashboard metrics for VPN services","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/960a628c-2f33-3367-a4ec-faca586888c5","info":{"title":"Service Health Historical Data APIs","description":"APIs for requesting historical data recorded by the Crosswork Service Health application.","termsOfService":"terms-of-service","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/ServiceHealth/sh_application_overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/aa/aaapp/v1/"}],"securitySchemes":{"bearerAuth":{"type":"apiKey","description":"Security token for authorizing requests for these APIs.","name":"Authorization","in":"header"}}},"spec":{"tags":["AaApplication"],"summary":"Get dashboard metrics for VPN services.","operationId":"AaApplication_GetDashboardMetrics","responses":{"200":{"description":"OK. The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","description":"Response - Get Dashboard metrics.","properties":{"status":{"type":"string","description":"Response Status - Get Dashboard metrics.","default":"UNKNOWN_STATUS","enum":["UNKNOWN_STATUS","SUCCESS","ERROR"],"$$ref":"#/components/schemas/DashboardMetricsResponseStatus"},"errmsg":{"description":"Error message","type":"string"},"servicesCount":{"description":"Count of services","type":"array","items":{"type":"object","description":"Current count of services of a particular service type","properties":{"serviceType":{"description":"specify the type of service","type":"string"},"totalCount":{"description":"current count of service","type":"integer","format":"int32"},"monitoredCount":{"description":"Monitored count","type":"integer","format":"int32"},"healthState":{"type":"object","description":"Health State Count","properties":{"initiated":{"type":"integer","description":"Initiated","format":"int32"},"down":{"type":"integer","description":"Down","format":"int32"},"degraded":{"type":"integer","description":"Degraded","format":"int32"},"good":{"type":"integer","description":"Good","format":"int32"},"unmonitored":{"type":"integer","description":"Unmonitored","format":"int32"}},"$$ref":"#/components/schemas/HealthStateCount"},"monitorState":{"type":"object","description":"Monitor State","properties":{"basic":{"type":"object","description":"Monitor State Count","properties":{"down":{"type":"integer","description":"Down","format":"int32"},"degraded":{"type":"integer","description":"Degraded","format":"int32"},"good":{"type":"integer","description":"Good","format":"int32"},"totalCount":{"type":"integer","description":"Total count","format":"int32"}},"$$ref":"#/components/schemas/MonitorStateCount"},"advanced":{"type":"object","description":"Monitor State Count","properties":{"down":{"type":"integer","description":"Down","format":"int32"},"degraded":{"type":"integer","description":"Degraded","format":"int32"},"good":{"type":"integer","description":"Good","format":"int32"},"totalCount":{"type":"integer","description":"Total count","format":"int32"}},"$$ref":"#/components/schemas/MonitorStateCount"}},"$$ref":"#/components/schemas/MonitorState"},"slaCount":{"description":"current count of SLA breaches","type":"integer","format":"int32"},"kpiCount":{"description":"current count of KPI breaches","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/DashboardServiceCount"}}},"$$ref":"#/components/schemas/DashboardMetricsResponse"},"example":{"data":[{"status":"SUCCESS","servicesCount":[{"serviceType":"L2VPN","totalCount":1,"healthState":{},"monitorState":{"basic":{},"advanced":{}}},{"serviceType":"L3VPN","totalCount":2,"monitoredCount":2,"healthState":{"degraded":2},"monitorState":{"basic":{},"advanced":{"degraded":2,"totalCount":2}}}]}]}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"description":"Gateway Runtime Error","type":"object","properties":{"error":{"description":"Error","type":"string"},"code":{"description":"Code","type":"integer","format":"int32"},"message":{"description":"Message","type":"string"},"details":{"description":"Details","type":"array","items":{"description":"Protobuf any","type":"object","properties":{"typeUrl":{"description":"Type URL","type":"string"},"value":{"description":"Value","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$","type":"string","format":"byte"}},"$$ref":"#/components/schemas/protobufAny"}}},"$$ref":"#/components/schemas/GatewayRuntimeError"},"example":{"data":[{"status":"SUCCESS"}]}}}}},"x-codegen-request-body-name":"body","__originalOperationId":"AaApplication_GetDashboardMetrics","security":[{"bearerAuth":[]}],"method":"post","path":"/dashboard/metrics"}}