Query an aggregated summary of site health data - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Query an aggregated summary of site health data","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"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":"queryAnAggregatedSummaryOfSiteHealthData_","tags":["Sites"],"deprecated":false,"summary":"Query an aggregated summary of site health data.","description":"Query an aggregated summary of all site health\nThis API provides the latest health data from a given `endTime`\nIf data is not ready for the provided endTime, the request will fail, and the error message will indicate the recommended endTime to use to retrieve a complete data set.\nThis behavior may occur if the provided endTime=currentTime, since we are not a real time system.\nWhen `endTime` is not provided, the API returns the latest data.\nThis API also provides issue data. The `startTime` query param can be used to specify the beginning point of time range to retrieve the active issue counts in. When this param is not provided, the default `startTime` will be 24 hours before endTime.\n\n Aggregated response data will NOT have unique identifier data populated.\n\n List of unique identifier data: [`id`, `siteHierarchy`,\n`siteHierarchyId`, `siteType`, `latitude`, `longitude`]\nPlease refer to the 'API Support Documentation' section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-siteHealthSummaries-1.0.3-resolved.yaml\n","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"X-CALLER-ID","description":"Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It's an optional header parameter that can be added to an API request.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"siteHierarchy","description":"The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named \"Global\" (Ex. `Global/AreaName/BuildingName/FloorName`)\n\nThis field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*`\n\nExamples:\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested)\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchyId","description":"The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`)\n\nThis field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*`\n\nExamples:\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested)\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteType","description":"The type of the site. A site can be an area, building, or floor.\n\nDefault when not provided will be `[floor,building,area]`\n\nExamples:\n\n`?siteType=area` (single siteType requested)\n\n`?siteType=area&siteType=building&siteType=floor` (multiple siteTypes requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"id","description":"The list of entity Uuids. (Ex.\"6bef213c-19ca-4170-8375-b694e251101c\")\nExamples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested)\nid=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with '&' separator)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"startTime":{"type":"integer","description":""},"endTime":{"type":"integer","description":""},"views":{"type":"array","items":{"type":"string"},"description":""},"attributes":{"type":"array","items":{"type":"string"},"description":""}},"description":"","$$ref":"#/components/schemas/QueryAnAggregatedSummaryOfSiteHealthDataRequest"}}},"required":true},"responses":{"200":{"description":"Sites health summaries aggregated response model \n\n*Unique identifiers may not be populated in response (ex. siteHierarchy, id, etc)*\n","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"siteHierarchyId":{"type":"string","description":""},"siteType":{"type":"string","description":""},"latitude":{"type":"number","description":""},"longitude":{"type":"number","description":""},"networkDeviceGoodHealthPercentage":{"type":"integer","description":""},"networkDeviceGoodHealthCount":{"type":"integer","description":""},"clientGoodHealthCount":{"type":"integer","description":""},"clientGoodHealthPercentage":{"type":"integer","description":""},"wiredClientGoodHealthPercentage":{"type":"integer","description":""},"wirelessClientGoodHealthPercentage":{"type":"integer","description":""},"clientCount":{"type":"integer","description":""},"wiredClientCount":{"type":"integer","description":""},"wirelessClientCount":{"type":"integer","description":""},"wiredClientGoodHealthCount":{"type":"integer","description":""},"wirelessClientGoodHealthCount":{"type":"integer","description":""},"networkDeviceCount":{"type":"integer","description":""},"accessDeviceCount":{"type":"integer","description":""},"accessDeviceGoodHealthCount":{"type":"integer","description":""},"coreDeviceCount":{"type":"integer","description":""},"coreDeviceGoodHealthCount":{"type":"integer","description":""},"distributionDeviceCount":{"type":"integer","description":""},"distributionDeviceGoodHealthCount":{"type":"integer","description":""},"routerDeviceCount":{"type":"integer","description":""},"routerDeviceGoodHealthCount":{"type":"integer","description":""},"wirelessDeviceCount":{"type":"integer","description":""},"wirelessDeviceGoodHealthCount":{"type":"integer","description":""},"apDeviceCount":{"type":"integer","description":""},"apDeviceGoodHealthCount":{"type":"integer","description":""},"wlcDeviceCount":{"type":"integer","description":""},"wlcDeviceGoodHealthCount":{"type":"integer","description":""},"switchDeviceCount":{"type":"integer","description":""},"switchDeviceGoodHealthCount":{"type":"integer","description":""},"accessDeviceGoodHealthPercentage":{"type":"integer","description":""},"coreDeviceGoodHealthPercentage":{"type":"integer","description":""},"distributionDeviceGoodHealthPercentage":{"type":"integer","description":""},"routerDeviceGoodHealthPercentage":{"type":"integer","description":""},"apDeviceGoodHealthPercentage":{"type":"integer","description":""},"wlcDeviceGoodHealthPercentage":{"type":"integer","description":""},"switchDeviceGoodHealthPercentage":{"type":"integer","description":""},"wirelessDeviceGoodHealthPercentage":{"type":"integer","description":""},"clientDataUsage":{"type":"number","description":""},"p1IssueCount":{"type":"integer","description":""},"p2IssueCount":{"type":"integer","description":""},"p3IssueCount":{"type":"integer","description":""},"p4IssueCount":{"type":"integer","description":""},"issueCount":{"type":"integer","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/QueryAnAggregatedSummaryOfSiteHealthDataResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"2782-ca59-4cc8-ad34","x-rapi-overview":"Query an aggregated summary of all site health\nThis API provides the latest health data from a given `endTime`\nIf data is not ready for the provided endTime, the request will fail, and the error message will indicate the recommended endTime to use to retrieve a complete data set.\nThis behavior may occur if the provided endTime=currentTime, since we are not a real time system.\nWhen `endTime` is not provided, the API returns the latest data.\nThis API also provides issue data. The `startTime` query param can be used to specify the beginning point of time range to retrieve the active issue counts in. When this param is not provided, the default `startTime` will be 24 hours before endTime.\n\n Aggregated response data will NOT have unique identifier data populated.\n\n List of unique identifier data: [`id`, `siteHierarchy`,\n`siteHierarchyId`, `siteType`, `latitude`, `longitude`]\nPlease refer to the 'API Support Documentation' section to understand which fields are supported. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-siteHealthSummaries-1.0.3-resolved.yaml\n","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Sites","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/siteHealthSummaries/summaryAnalytics","x-rapi-publicPath":"/dna/data/api/v1/siteHealthSummaries/summaryAnalytics","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"25~MINUTE","__originalOperationId":"queryAnAggregatedSummaryOfSiteHealthData.","method":"post","path":"/dna/data/api/v1/siteHealthSummaries/summaryAnalytics"}}