{"type":"api","title":"Sensor Test Results","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":"sensorTestResults","tags":["Wireless"],"summary":"Sensor Test Results","deprecated":false,"description":"Intent API to get SENSOR test result summary","parameters":[{"name":"siteId","description":"Assurance site UUID","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"startTime","description":"The epoch time in milliseconds","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","description":"The epoch time in milliseconds","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"testFailureBy","description":"Obtain failure statistics group by \"area\", \"building\", or \"floor\" (case insensitive)","required":false,"schema":{"type":"string","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":{"type":"object","properties":{"summary":{"type":"object","properties":{"totalTestCount":{"type":"integer","description":"Total test count"},"ONBOARDING":{"type":"object","properties":{"AUTH":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"integer","description":"Total failed test count"}},"description":""},"DHCP":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"number","description":"Total failed test count"}},"description":""},"ASSOC":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"integer","description":"Total failed test count"}},"description":""}},"description":""},"PERFORMANCE":{"type":"object","properties":{"IPSLASENDER":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"integer","description":"Total failed test count"}},"description":""}},"description":""},"NETWORK_SERVICES":{"type":"object","properties":{"DNS":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"number","description":"Total failed test count"}},"description":""}},"description":""},"APP_CONNECTIVITY":{"type":"object","properties":{"HOST_REACHABILITY":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"number","description":"Total failed test count"}},"description":""},"WEBSERVER":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"integer","description":"Total failed test count"}},"description":""},"FILETRANSFER":{"type":"object","properties":{"passCount":{"type":"number","description":"Total passed test count"},"failCount":{"type":"integer","description":"Total failed test count"}},"description":""}},"description":""},"RF_ASSESSMENT":{"type":"object","properties":{"DATA_RATE":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"integer","description":"Total failed test count"}},"description":""},"SNR":{"type":"object","properties":{"passCount":{"type":"integer","description":"Total passed test count"},"failCount":{"type":"number","description":"Total failed test count"}},"description":""}},"description":""},"EMAIL":{"type":"object","properties":{"MAILSERVER":{"type":"object","properties":{"passCount":{"type":"number","description":"Total passed test count"},"failCount":{"type":"integer","description":"Total failed test count"}},"description":""}},"description":""}},"description":"Overall passed/failed test count of each category"},"failureStats":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"integer","description":"The error code"},"errorTitle":{"type":"string","description":"The error title"},"testType":{"type":"string","description":"The test type"},"testCategory":{"type":"string","description":"The test category"}}},"description":"Failure reason by test type"}},"description":""}},"description":"","$$ref":"#/components/schemas/SensorTestResultsResponse"}}}},"202":{"description":"The request has been accepted for execution.","content":{}},"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":{}},"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":"87ae-7b21-4f0b-a838","x-rapi-overview":"Intent API to get SENSOR test result summary","x-rapi-domain":"Connectivity","x-rapi-subdomain":"Wireless","x-rapi-version":"1.0.0","x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"10~1","__originalOperationId":"sensorTestResults","method":"get","path":"/dna/intent/api/v1/AssuranceGetSensorTestResults"}}