{"type":"api","title":"Get Overall Client Health","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-6/abf92d064d2ae44ab6837c3d88edf9d690a3dafe/e781f25e-db90-3cf3-87fc-525e5b8797c6","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.6","version":"2.3.7.6"},"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":"getOverallClientHealth","tags":["Clients"],"summary":"Get Overall Client Health","description":"Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time","parameters":[{"name":"timestamp","description":"Epoch time(in milliseconds) when the Client health data is required","required":false,"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":"Response output version"},"response":{"type":"array","items":{"type":"object","properties":{"siteId":{"type":"string","description":"Site UUID or 'global'"},"scoreDetail":{"type":"array","items":{"type":"object","properties":{"scoreCategory":{"type":"object","properties":{"scoreCategory":{"type":"string","description":"Health score category"},"value":{"type":"string","description":"Health score category value"}},"description":"Category of the overall health score"},"scoreValue":{"type":"number","description":"Percentage of GOOD health score in the category. (-1 means not applicable for the category)"},"clientCount":{"type":"integer","description":"Total client count"},"clientUniqueCount":{"type":"integer","description":"Total unique client count"},"maintenanceAffectedClientCount":{"type":"integer","description":"Total client count affected by maintenance"},"randomMacCount":{"type":"integer","description":"Total client count with random MAC count"},"duidCount":{"type":"integer","description":"Device UUID count"},"starttime":{"type":"integer","description":"UTC timestamp of data start time"},"endtime":{"type":"integer","description":"UTC timestamp of data end time"},"connectedToUdnCount":{"type":"integer","description":"Total connected to UDN count"},"unconnectedToUdnCount":{"type":"integer","description":"Total unconnected to UDN count"},"scoreList":{"type":"array","items":{"type":"object","properties":{"scoreCategory":{"type":"object","properties":{"scoreCategory":{"type":"string","description":"Category of the overall health score"},"value":{"type":"string","description":"Health score category value"}},"description":"Category of the overall health score"},"scoreValue":{"type":"number","description":"Percentage of GOOD health score in the category. (-1 means not applicable for the category)"},"clientCount":{"type":"integer","description":"Total client count"},"clientUniqueCount":{"type":"integer","description":"Total unique client count"},"maintenanceAffectedClientCount":{"type":"integer","description":"Total client count affected by maintenance"},"randomMacCount":{"type":"integer","description":"Total client count with random MAC count"},"duidCount":{"type":"integer","description":"Device UUID count"},"starttime":{"type":"integer","description":"UTC timestamp of data start time"},"endtime":{"type":"integer","description":"UTC timestamp of data end time"},"connectedToUdnCount":{"type":"integer","description":"Total connected to UDN count"},"unconnectedToUdnCount":{"type":"integer","description":"Total unconnected to UDN count"}}},"description":"List of additional score objects"}}},"description":"Overall health score information"}}},"description":"List of overall health objects"}},"description":"Overall client health object","$$ref":"#/components/schemas/HealthDetail"}}}},"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":"3f9f-d80e-4df9-863c","x-rapi-overview":"Returns Overall Client Health information by Client type (Wired and Wireless) for any given point of time","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Clients","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/assurance/v1/intent/clientHealth","x-rapi-publicPath":"/dna/intent/api/v1/client-health","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getOverallClientHealth","method":"get","path":"/dna/intent/api/v1/client-health"}}