Retrieves the list of ThousandEyes test results along with related metrics - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Retrieves the list of ThousandEyes test results along with related metrics","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":"retrievesTheListOfThousandEyesTestResultsAlongWithRelatedMetrics","tags":["Applications"],"summary":"Retrieves the list of ThousandEyes test results along with related metrics","deprecated":false,"description":"Retrieves the list of ThousandEyes test results along with related metrics. If `startTime` and `endTime` are not provided, the API defaults to the last 24 hours.\n\nPlease note that `siteId` filter (if used) should be using only site UUIDs of buildings.\n 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-thousandEyesTestResults-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":"siteId","description":"The site UUID without the top level hierarchy. `siteId` must be a site UUID of a building. The list of buildings can be fetched using API `GET /dna/intent/api/v1/sites?type=building`.\nExamples:\n\n`siteId=buildingUuid` (single siteId requested)\n\n`siteId=buildingUuid1&siteId=buildingUuid2` (multiple siteId requested)\n","required":false,"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","required":false,"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":"testId","description":"Unique identifier of the ThousandEyes test.\nExamples:\n\n`testId=2043918` (filter for single testId)\n\n`testId=2043918&testId=129440` (filter for multiple testIds)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"testName","description":"Name of the ThousandEyes test. This supports `*` wildcard, and filtering is case-insensitve.\n\nExamples:\n\n`testName=Cisco Webex` (exact match)\n\n`testName=Microsoft*` (starts with given string)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"testType","description":"Type of the ThousandEyes test. Please note that Catalyst Center supports only a subset of all possible ThousandEyes test types.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"agentId","description":"Unique identifier of the ThousandEyes agent.\nExamples:\n\n`agentId=199345` (filter for single agentId)\n\n`agentId=1993458&agentId=499387` (filter for multiple agentIds)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"networkDeviceName","description":"Name of the network device as per the inventory. This supports `*` wildcard, and filtering is case-insensitve.\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"attribute","description":"List of attributes related to resource that can be requested to only be part of the response along with the required attributes.\n\nExamples:\n\n`attribute=testName` (single attribute requested)\n\n`attribute=testId&attribute=testName&attribute=averageLatency` (multiple attributes requested)\n. For valid attributes, verify the documentation.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to return","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"offset","description":"Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"sortBy","description":"Attribute name by which the results should be sorted","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"The sort order of the field ascending or descending.","schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response for the list of ThousandEyes test results","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":""},"testId":{"type":"string","description":""},"testName":{"type":"string","description":""},"testType":{"type":"string","description":""},"agentId":{"type":"string","description":""},"agentName":{"type":"string","description":""},"networkDeviceName":{"type":"string","description":""},"networkDeviceType":{"type":"string","description":""},"siteId":{"type":"string","description":""},"siteName":{"type":"string","description":""},"testInterval":{"type":"integer","description":""},"testTarget":{"type":"string","description":""},"sampleTime":{"type":"integer","description":""},"averagePacketLoss":{"type":"number","description":""},"latestPacketLoss":{"type":"number","description":""},"maxPacketLoss":{"type":"number","description":""},"averageJitter":{"type":"object","properties":{},"description":""},"latestJitter":{"type":"object","properties":{},"description":""},"maxJitter":{"type":"object","properties":{},"description":""},"averageLatency":{"type":"integer","description":""},"latestLatency":{"type":"integer","description":""},"maxLatency":{"type":"integer","description":""},"averageResponseTime":{"type":"integer","description":""},"latestResponseTime":{"type":"integer","description":""},"maxResponseTime":{"type":"integer","description":""},"averageMos":{"type":"object","properties":{},"description":""},"latestMos":{"type":"object","properties":{},"description":""},"minMos":{"type":"object","properties":{},"description":""},"averagePdv":{"type":"object","properties":{},"description":""},"latestPdv":{"type":"object","properties":{},"description":""},"maxPdv":{"type":"object","properties":{},"description":""},"totalAlerts":{"type":"number","description":""},"totalActiveAlerts":{"type":"integer","description":""},"totalSamplingTests":{"type":"integer","description":""},"totalFailureSamplingTests":{"type":"integer","description":""},"totalErrorsSamplingTests":{"type":"integer","description":""}}},"description":""},"page":{"type":"object","properties":{"limit":{"type":"integer","description":""},"offset":{"type":"integer","description":""},"count":{"type":"integer","description":""},"sortBy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":""},"order":{"type":"string","description":""}}},"description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/RetrievesTheListOfThousandEyesTestResultsAlongWithRelatedMetricsResponse"}}}},"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":{}}},"x-rapi-id":"38bf-4bbf-4aba-9879","x-rapi-overview":"Retrieves the list of ThousandEyes test results along with related metrics. If `startTime` and `endTime` are not provided, the API defaults to the last 24 hours.\n\nPlease note that `siteId` filter (if used) should be using only site UUIDs of buildings.\n 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-thousandEyesTestResults-1.0.0-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Applications","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/thousandEyesTestResults","x-rapi-publicPath":"/dna/data/api/v1/thousandEyesTestResults","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"25~MINUTE","__originalOperationId":"retrievesTheListOfThousandEyesTestResultsAlongWithRelatedMetrics","method":"get","path":"/dna/data/api/v1/thousandEyesTestResults"}}