Qodex.ai

Retrieve path visualization network scheduled test results

GET {{baseUrl}}/endpoint/test-results/scheduled-tests/:testId/path-vis?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&cursor=

Returns a summary of the path visualization data collected from each endpoint agent to the destination. In each path visualization attempt, one attempt is made to reach the destination. Each set of data is summarized, based on response time, number of hops, and response time to the target. A time frame must be specified, or the most recent round within last 2 hours is returned.

Request Params

KeyDatatypeRequiredDescription
aidnumberA unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
windowstringA dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: s for seconds (default if no type is specified), m for minutes, h for hours, d for days, and w for weeks.
For a precise date range, use startDate and endDate.
startDatestringUse with the endDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
endDatestringDefaults to current time the request is made. Use with the startDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
cursornull(Optional) Opaque cursor used for pagination. Clients should use next value from _links instead of this parameter.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"results":[{"aid":"1234","agentId":"861b7557-cd57-4bbb-b648-00bddf88ef49","roundId":1384309800,"serverIp":"185.199.108.153","networkProfile":{"ipAddress":"10.0.0.13","subnetMask":"255.255.255.0","publicIpAddress":"84.255.241.1","localPrefix":"10.0.0.0","publicIpRange":"84.255.241.0-84.255.241.255","dnsServers":["8.8.8.8","8.8.8.4"],"hardwareType":"wireless","interfaceName":"en0","error":"An operation timed out.","gateway":"10.0.0.1","wirelessProfile":{"ssid":"Internet for the masses","bssid":"4c:ba:ba:f4:fa:fa","channel":1,"phyMode":"802.11n","rssi":-38,"noise":-95,"quality":100,"txRate":130,"vendor":"Cisco"},"proxyProfile":{"method":"System","proxies":[{"bypass":"*.local;169.254/16","proxy":"\u003cdirect\u003e"},{"bypass":"*.local;169.254/16","proxy":"\u003cdirect\u003e"}]},"ethernetProfile":{"linkSpeed":860},"previousInterface":{"ipAddress":"10.0.0.13","subnetMask":"255.255.255.0","publicIpAddress":"84.255.241.1","localPrefix":"10.0.0.0","publicIpRange":"84.255.241.0-84.255.241.255","dnsServers":["8.8.8.8","8.8.8.4"],"hardwareType":"wireless","interfaceName":"en0"}},"systemMetrics":{"startTimeMs":1581508857327,"endTimeMs":1581508867333,"cpuUtilization":{"min":0.22,"max":0.75,"mean":0.55,"median":0.61,"stdDev":0.01,"count":150},"physicalMemoryUsedBytes":{"min":1.2,"max":2.5,"mean":1.77,"median":1.85,"stdDev":0.25,"count":155},"physicalMemoryTotalBytes":1024},"originalTargetProfile":{"remotePort":80,"remoteIpAddress":"120.98.134.7","protocol":"tcp"},"vpnProfile":{"vpnClientAddresses":["184.81.113.85","13.129.91.62"],"vpnClientNetworkRange":["9.88.37.27","9.88.37.27"],"vpnGatewayAddress":"120.98.134.7","vpnType":"cisco-anyconnect"},"asnDetails":{"asName":"ThousandEyes, Inc","asNumber":394101},"server":"www.google.com:443","sourceIp":"196.40.106.237","sourcePrefix":"196.40.96.0/20","location":"San Francisco Area","pathTraces":[{"ipAddress":"196.40.106.237","numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","responseTime":1500},{"ipAddress":"196.40.106.237","numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","responseTime":1500}]},{"aid":"1234","agentId":"861b7557-cd57-4bbb-b648-00bddf88ef49","roundId":1384309800,"serverIp":"185.199.108.153","networkProfile":{"ipAddress":"10.0.0.13","subnetMask":"255.255.255.0","publicIpAddress":"84.255.241.1","localPrefix":"10.0.0.0","publicIpRange":"84.255.241.0-84.255.241.255","dnsServers":["8.8.8.8","8.8.8.4"],"hardwareType":"wireless","interfaceName":"en0","error":"An operation timed out.","gateway":"10.0.0.1","wirelessProfile":{"ssid":"Internet for the masses","bssid":"4c:ba:ba:f4:fa:fa","channel":1,"phyMode":"802.11n","rssi":-38,"noise":-95,"quality":100,"txRate":130,"vendor":"Cisco"},"proxyProfile":{"method":"System","proxies":[{"bypass":"*.local;169.254/16","proxy":"\u003cdirect\u003e"},{"bypass":"*.local;169.254/16","proxy":"\u003cdirect\u003e"}]},"ethernetProfile":{"linkSpeed":860},"previousInterface":{"ipAddress":"10.0.0.13","subnetMask":"255.255.255.0","publicIpAddress":"84.255.241.1","localPrefix":"10.0.0.0","publicIpRange":"84.255.241.0-84.255.241.255","dnsServers":["8.8.8.8","8.8.8.4"],"hardwareType":"wireless","interfaceName":"en0"}},"systemMetrics":{"startTimeMs":1581508857327,"endTimeMs":1581508867333,"cpuUtilization":{"min":0.22,"max":0.75,"mean":0.55,"median":0.61,"stdDev":0.01,"count":150},"physicalMemoryUsedBytes":{"min":1.2,"max":2.5,"mean":1.77,"median":1.85,"stdDev":0.25,"count":155},"physicalMemoryTotalBytes":1024},"originalTargetProfile":{"remotePort":80,"remoteIpAddress":"120.98.134.7","protocol":"tcp"},"vpnProfile":{"vpnClientAddresses":["184.81.113.85","13.129.91.62"],"vpnClientNetworkRange":["9.88.37.27","9.88.37.27"],"vpnGatewayAddress":"120.98.134.7","vpnType":"cisco-anyconnect"},"asnDetails":{"asName":"ThousandEyes, Inc","asNumber":394101},"server":"www.google.com:443","sourceIp":"196.40.106.237","sourcePrefix":"196.40.96.0/20","location":"San Francisco Area","pathTraces":[{"ipAddress":"196.40.106.237","numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","responseTime":1500},{"ipAddress":"196.40.106.237","numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","responseTime":1500}]}],"test":{"type":"agent-to-server","aid":"1234","_links":{"self":{"href":"https://api.thousandeyes.com/v7/endpoint/tests/{type}/281474976710706"},"testResults":[{"href":"https://api.thousandeyes.com/v7/endpoint/test-results/scheduled-tests/281474976710706/network/filter"},{"href":"https://api.thousandeyes.com/v7/endpoint/test-results/scheduled-tests/281474976710706/pathvis"}]},"agentSelectorConfig":{"agentSelectorType":"all-agents","maxMachines":25},"createdDate":"2022-07-17T22:00:54Z","interval":60,"isEnabled":true,"isSavedEvent":false,"hasPathTraceInSession":true,"modifiedDate":"2022-07-17T22:00:54Z","networkMeasurements":true,"port":80,"protocol":"icmp","server":"www.example.com","testId":"281474976710706","testName":"Test name","tcpProbeMode":"auto","labels":[{"labelId":"961","name":"Artem label","isBuiltin":false},{"labelId":"961","name":"Artem label","isBuiltin":false}]},"startDate":"2022-07-17T22:00:54Z","endDate":"2022-07-18T22:00:54Z","_links":{"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"dolor dolor ea elit id","deprecation":"occaecat ex minim sed","name":"non sunt","profile":"irure tempor nostrud consectetur","title":"cillum dol","hreflang":"adipisicing incididunt in eu"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"velit occaecat","deprecation":"nisi consectetur","name":"amet","profile":"reprehender","title":"eiusmod consequat veniam","hreflang":"velit i"}}}