{"type":"api","title":"Get Site Health","meta":{"id":"/apps/pubhub/media/dna-center-235/0e427c513038595590fc5a0593cb0e208dd78571/2192edf3-d24e-3461-ab8c-12a97b547df4","swagger":"2.0","info":{"description":"Cisco DNA Center Platform v. 2.3.5","version":"2.3.5","title":"Intent API"},"schemes":["https"],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"getSiteHealth","tags":["Sites"],"summary":"Get Site Health","description":"Returns Overall Health information for all sites","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"timestamp","description":"Epoch time(in milliseconds) when the Site Hierarchy data is required","default":"","required":false,"type":"string","in":"query"},{"name":"siteType","description":"Type of the site to return. AREA or BUILDING. Default to AREA","default":"AREA","required":false,"type":"string","in":"query"},{"name":"offset","description":"The offset value, starting from 1, of the first returned site entry. Default is 1.","default":1,"required":false,"type":"number","in":"query"},{"name":"limit","description":"The max number of sites in the returned data set. Default is 25, and max at 50","default":25,"required":false,"type":"number","in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"siteName":{"type":"string"},"siteId":{"type":"string"},"parentSiteId":{"type":"string"},"parentSiteName":{"type":"string"},"siteType":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"healthyNetworkDevicePercentage":{"type":"object","properties":{}},"healthyClientsPercentage":{"type":"object","properties":{}},"clientHealthWired":{"type":"object","properties":{}},"clientHealthWireless":{"type":"object","properties":{}},"numberOfClients":{"type":"object","properties":{}},"numberOfNetworkDevice":{"type":"object","properties":{}},"networkHealthAverage":{"type":"object","properties":{}},"networkHealthAccess":{"type":"object","properties":{}},"networkHealthCore":{"type":"object","properties":{}},"networkHealthDistribution":{"type":"object","properties":{}},"networkHealthRouter":{"type":"object","properties":{}},"networkHealthWireless":{"type":"object","properties":{}},"networkHealthOthers":{"type":"object","properties":{}},"numberOfWiredClients":{"type":"object","properties":{}},"numberOfWirelessClients":{"type":"object","properties":{}},"totalNumberOfConnectedWiredClients":{"type":"object","properties":{}},"totalNumberOfActiveWirelessClients":{"type":"object","properties":{}},"wiredGoodClients":{"type":"object","properties":{}},"wirelessGoodClients":{"type":"object","properties":{}},"overallGoodDevices":{"type":"object","properties":{}},"accessGoodCount":{"type":"object","properties":{}},"accessTotalCount":{"type":"object","properties":{}},"coreGoodCount":{"type":"object","properties":{}},"coreTotalCount":{"type":"object","properties":{}},"distributionGoodCount":{"type":"object","properties":{}},"distributionTotalCount":{"type":"object","properties":{}},"routerGoodCount":{"type":"object","properties":{}},"routerTotalCount":{"type":"object","properties":{}},"wirelessDeviceGoodCount":{"type":"object","properties":{}},"wirelessDeviceTotalCount":{"type":"object","properties":{}},"applicationHealth":{"type":"object","properties":{}},"applicationGoodCount":{"type":"object","properties":{}},"applicationTotalCount":{"type":"object","properties":{}},"applicationBytesTotalCount":{"type":"object","properties":{}},"dnacInfo":{"type":"object","properties":{}},"applicationHealthStats":{"type":"object","properties":{"appTotalCount":{"type":"number"},"businessRelevantAppCount":{"type":"object","properties":{"poor":{"type":"number"},"fair":{"type":"number"},"good":{"type":"number"}}},"businessIrrelevantAppCount":{"type":"object","properties":{"poor":{"type":"number"},"fair":{"type":"number"},"good":{"type":"number"}}},"defaultHealthAppCount":{"type":"object","properties":{"poor":{"type":"number"},"fair":{"type":"number"},"good":{"type":"number"}}}}}}}}},"$$ref":"#/definitions/GetSiteHealthResponse"}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect)."},"401":{"description":"The client's authentication credentials included with the request are missing or invalid."},"404":{"description":"The client made a request for a resource that does not exist."},"500":{"description":"The server could not fulfill the request."}},"__originalOperationId":"getSiteHealth","method":"get","path":"/dna/intent/api/v1/site-health"}}