{"type":"api","title":"Get Overall Network Health","meta":{"id":"/apps/pubhub/media/cisco-dna-center-api-2-3-7/3309b3bd96fb020da21f4aafc83d1cba46673bc3/3f2660a3-5586-3ef5-a257-2e69a95dd4c9","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7","version":"2.3.7"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getOverallNetworkHealth","tags":["Topology"],"summary":"Get Overall Network Health","description":"Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time","parameters":[{"name":"timestamp","description":"UTC timestamp of network health data in milliseconds","schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","description":"This output's version string"},"response":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","description":"Date-time string"},"healthScore":{"type":"integer","description":"Health score"},"totalCount":{"type":"integer","description":"Total health count"},"goodCount":{"type":"integer","description":"Total good health count"},"noHealthCount":{"type":"integer","description":"Total no health count"},"unmonCount":{"type":"integer","description":"Total no health count"},"fairCount":{"type":"integer","description":"Total fair health count"},"badCount":{"type":"integer","description":"Total bad health count"},"maintenanceModeCount":{"type":"integer","description":"Total maintenance mode count"},"entity":{"type":"string","description":"Entity of the health data"},"timeinMillis":{"type":"integer","description":"UTC time value of property 'time' in milliseconds"}}},"description":"Overall network health data"},"measuredBy":{"type":"string","description":"Overall network health measure by 'global'"},"latestMeasuredByEntity":{"type":"string","description":"Latest measured by entity"},"latestHealthScore":{"type":"integer","description":"Latest health score value"},"monitoredDevices":{"type":"integer","description":"Number of monitored devices"},"monitoredHealthyDevices":{"type":"integer","description":"Number of healthy devices"},"monitoredUnHealthyDevices":{"type":"integer","description":"Number of unhealthy devices"},"unMonitoredDevices":{"type":"integer","description":"Number of un-monitored devices"},"noHealthDevices":{"type":"integer","description":"Number of un-monitored devices"},"totalDevices":{"type":"integer","description":"Total number of devices"},"monitoredPoorHealthDevices":{"type":"integer","description":"Number of poor health devices"},"monitoredFairHealthDevices":{"type":"integer","description":"Number of fair health devices"},"healthContributingDevices":{"type":"integer","description":"Number of health contributing devices"},"healthDistirubution":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string","description":"Device category in this health data"},"totalCount":{"type":"integer","description":"Total device count"},"healthScore":{"type":"integer","description":"Health score"},"goodPercentage":{"type":"number","description":"Good health percent"},"badPercentage":{"type":"number","description":"Poor health percent"},"fairPercentage":{"type":"number","description":"Fair health percent"},"noHealthPercentage":{"type":"number","description":"No health percent"},"unmonPercentage":{"type":"number","description":"No health percent"},"goodCount":{"type":"number","description":"Good health count"},"badCount":{"type":"number","description":"Poor health count"},"fairCount":{"type":"number","description":"Fair health count"},"noHealthCount":{"type":"number","description":"No health count"},"unmonCount":{"type":"number","description":"No health count"},"thirdPartyDeviceCount":{"type":"number","description":"Third party device count"},"kpiMetrics":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Health key"},"value":{"type":"string","description":"Health value"}}},"description":"Health metrics"}}},"description":"Health distribution"}},"description":"Overall network health data","$$ref":"#/components/schemas/GetOverallNetworkHealthResponse"}}}},"400":{"description":" The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":" The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"This user is forbidden to access this resource.","content":{}},"404":{"description":" The client made a request for a resource that does not exist.","content":{}},"500":{"description":" The server could not fulfill the request.","content":{}}},"x-rapi-id":"7997-6a34-4409-bfbb","x-rapi-overview":"Returns Overall Network Health information by Device category (Access, Distribution, Core, Router, Wireless) for any given point of time","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Topology","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/assurance/v1/intent/networkHealth","x-rapi-publicPath":"/dna/intent/api/v1/network-health","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getOverallNetworkHealth","method":"get","path":"/dna/intent/api/v1/network-health"}}