{"type":"api","title":"Get site analytics for one site","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/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":"getSiteAnalyticsForOneSite_","tags":["Sites"],"summary":"Get site analytics for one site.","deprecated":false,"description":"Returns site analytics for the given site. 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-SiteKpiSummaries-1.0.0-resolved.yaml","parameters":[{"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":"id","description":"The Site UUID","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"taskId","description":"used to retrieve asynchronously processed & stored data. When this parameter is used, the rest of the request params will be ignored.\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"startTime","description":"Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"ssid","description":"SSID is the name of wireless network to which client connects to. It is also referred to as WLAN ID - Wireless Local Area Network Identifier.\nExamples:\n`ssid=Alpha` (single ssid requested)\n`ssid=Alpha&ssid=Guest` (multiple ssid requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"band","description":"WiFi frequency band that client or Access Point operates. Band value is represented in Giga Hertz - GHz\nExamples:\n`band=5` (single band requested)\n`band=2.4&band=6` (multiple band requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"failureCategory","description":"Category of failure when a client fails to meet the threshold.\nExamples:\n`failureCategory=AUTH` (single failure category requested)\n`failureCategory=AUTH&failureCategory=DHCP` (multiple failure categories requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"failureReason","description":"Reason for failure when a client fails to meet the threshold.\nExamples:\n`failureReason=MOBILITY_FAILURE` (single ssid requested)\n`failureReason=REASON_IPLEARN_CONNECT_TIMEOUT&failureReason=ST_EAP_TIMEOUT` (multiple ssid requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"view","description":"\u003cp\u003eThe name of the View. Each view represents a specific data set. Please refer to the \u003ccode\u003eSiteAnalyticsView\u003c/code\u003e Model for supported views. View is predefined set of attributes supported by the API. Only the attributes related to the given view will be part of the API response along with default attributes. If multiple views are provided, then response will contain attributes from all those views. If no views are specified, all attributes will be returned.\u003c/p\u003e\u003ctable\u003e\u003cthead\u003e\u003ctr\u003e\u003cth\u003eView Name\u003c/th\u003e\u003cth\u003eIncluded Attributes\u003c/th\u003e\u003c/tr\u003e\u003c/thead\u003e\u003ctbody\u003e\u003ctr\u003e\u003ctd\u003e\u003ccode\u003ecoverage\u003c/code\u003e\u003c/td\u003e\u003ctd\u003ecoverageAverage, coverageSuccessPercentage, coverageSuccessCount, coverageTotalCount, coverageFailureCount, coverageClientCount, coverageImpactedEntities, coverageFailureImpactedEntities, coverageFailureMetrics\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ccode\u003eonboardingAttempts\u003c/code\u003e\u003c/td\u003e\u003ctd\u003eonboardingAttemptsSuccessPercentage, onboardingAttemptsSuccessCount, onboardingAttemptsTotalCount, onboardingAttemptsFailureCount, onboardingAttemptsClientCount, onboardingAttemptsImpactedEntities, onboardingAttemptsFailureImpactedEntities, onboardingAttemptsFailureMetrics\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ccode\u003eonboardingDuration\u003c/code\u003e\u003c/td\u003e\u003ctd\u003eonboardingDurationAverage, onboardingDurationSuccessPercentage, onboardingDurationSuccessCount, onboardingDurationTotalCount, onboardingDurationFailureCount, onboardingDurationClientCount, onboardingDurationImpactedEntities, onboardingDurationFailureImpactedEntities, onboardingDurationFailureMetrics\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ccode\u003eroamingAttempts\u003c/code\u003e\u003c/td\u003e\u003ctd\u003eroamingAttemptsSuccessPercentage, roamingAttemptsSuccessCount, roamingAttemptsTotalCount, roamingAttemptsFailureCount, roamingAttemptsClientCount, roamingAttemptsImpactedEntities, roamingAttemptsFailureImpactedEntities, roamingAttemptsFailureMetrics\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ccode\u003eroamingDuration\u003c/code\u003e\u003c/td\u003e\u003ctd\u003eroamingDurationAverage, roamingDurationSuccessPercentage, roamingDurationSuccessCount, roamingDurationTotalCount, roamingDurationFailureCount, roamingDurationClientCount, roamingDurationImpactedEntities, roamingDurationFailureImpactedEntities, roamingDurationFailureMetrics\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003e\u003ccode\u003econnectionSpeed\u003c/code\u003e\u003c/td\u003e\u003ctd\u003econnectionSpeedAverage, connectionSpeedSuccessPercentage, connectionSpeedSuccessCount, connectionSpeedTotalCount, connectionSpeedFailureCount, connectionSpeedClientCount, connectionSpeedImpactedEntities, connectionSpeedFailureImpactedEntities, connectionSpeedFailureMetrics\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003cp\u003eExamples: \u003ccode\u003eview=connectionSpeed\u003c/code\u003e (single view requested) \u003ccode\u003eview=roamingDuration&view=roamingAttempts\u003c/code\u003e (multiple views requested) \u003c/p\u003e","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"List of attributes related to site analytics. If these are provided, then only those attributes will be part of response along with the default attributes.\nExamples: `attribute=coverageAverage` (single attribute requested) `attribute=coverageFailureMetrics&attribute=coverageTotalCount` (multiple attributes requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response containing site anlytics details for one site","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"id":{"type":"string","description":""},"siteId":{"type":"string","description":""},"siteHierarchyId":{"type":"string","description":""},"siteHierarchy":{"type":"string","description":""},"siteType":{"type":"string","description":""},"apCount":{"type":"integer","description":""},"coverageAverage":{"type":"integer","description":""},"coverageSuccessPercentage":{"type":"integer","description":""},"coverageSuccessCount":{"type":"integer","description":""},"coverageTotalCount":{"type":"integer","description":""},"coverageFailureCount":{"type":"integer","description":""},"coverageClientCount":{"type":"integer","description":""},"coverageImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"coverageFailureImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"coverageFailureMetrics":{"type":"object","properties":{"failureApCount":{"type":"integer","description":""},"failureClientCount":{"type":"integer","description":""},"failurePercentage":{"type":"integer","description":""}},"description":""},"onboardingAttemptsSuccessPercentage":{"type":"integer","description":""},"onboardingAttemptsSuccessCount":{"type":"integer","description":""},"onboardingAttemptsTotalCount":{"type":"integer","description":""},"onboardingAttemptsFailureCount":{"type":"integer","description":""},"onboardingAttemptsClientCount":{"type":"integer","description":""},"onboardingAttemptsImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"onboardingAttemptsFailureImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"onboardingAttemptsFailureMetrics":{"type":"object","properties":{"failureApCount":{"type":"integer","description":""},"failureClientCount":{"type":"integer","description":""},"failurePercentage":{"type":"integer","description":""}},"description":""},"onboardingDurationAverage":{"type":"integer","description":""},"onboardingDurationSuccessPercentage":{"type":"integer","description":""},"onboardingDurationSuccessCount":{"type":"integer","description":""},"onboardingDurationTotalCount":{"type":"integer","description":""},"onboardingDurationFailureCount":{"type":"integer","description":""},"onboardingDurationClientCount":{"type":"integer","description":""},"onboardingDurationImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"onboardingDurationFailureImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"onboardingDurationFailureMetrics":{"type":"object","properties":{"failureApCount":{"type":"integer","description":""},"failureClientCount":{"type":"integer","description":""},"failurePercentage":{"type":"integer","description":""}},"description":""},"roamingAttemptsSuccessPercentage":{"type":"integer","description":""},"roamingAttemptsSuccessCount":{"type":"integer","description":""},"roamingAttemptsTotalCount":{"type":"integer","description":""},"roamingAttemptsFailureCount":{"type":"integer","description":""},"roamingAttemptsClientCount":{"type":"integer","description":""},"roamingAttemptsImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"roamingAttemptsFailureImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"roamingAttemptsFailureMetrics":{"type":"object","properties":{"failureApCount":{"type":"integer","description":""},"failureClientCount":{"type":"integer","description":""},"failurePercentage":{"type":"integer","description":""}},"description":""},"roamingDurationAverage":{"type":"integer","description":""},"roamingDurationSuccessPercentage":{"type":"integer","description":""},"roamingDurationSuccessCount":{"type":"integer","description":""},"roamingDurationTotalCount":{"type":"integer","description":""},"roamingDurationFailureCount":{"type":"integer","description":""},"roamingDurationClientCount":{"type":"integer","description":""},"roamingDurationImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"roamingDurationFailureImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"roamingDurationFailureMetrics":{"type":"object","properties":{"failureApCount":{"type":"integer","description":""},"failureClientCount":{"type":"integer","description":""},"failurePercentage":{"type":"integer","description":""}},"description":""},"connectionSpeedAverage":{"type":"integer","description":""},"connectionSpeedSuccessPercentage":{"type":"integer","description":""},"connectionSpeedSuccessCount":{"type":"integer","description":""},"connectionSpeedTotalCount":{"type":"integer","description":""},"connectionSpeedFailureCount":{"type":"integer","description":""},"connectionSpeedClientCount":{"type":"integer","description":""},"connectionSpeedImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"connectionSpeedFailureImpactedEntities":{"type":"object","properties":{"buildingCount":{"type":"integer","description":""},"floorCount":{"type":"integer","description":""},"sitesCount":{"type":"integer","description":""},"apCount":{"type":"integer","description":""}},"description":""},"connectionSpeedFailureMetrics":{"type":"object","properties":{"failureApCount":{"type":"integer","description":""},"failureClientCount":{"type":"integer","description":""},"failurePercentage":{"type":"integer","description":""}},"description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetSiteAnalyticsForOneSiteResponse"}}}},"202":{"description":"Response model for asynchronous APIs to use for providing corresponding task information to API caller","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","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 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":"65be-bad5-48b9-9134","x-rapi-overview":"Returns site analytics for the given site. 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-SiteKpiSummaries-1.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Sites","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/siteKpiSummaries/${id}","x-rapi-publicPath":"/dna/data/api/v1/siteKpiSummaries/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getSiteAnalyticsForOneSite.","method":"get","path":"/dna/data/api/v1/siteKpiSummaries/{id}"}}