Retrieve network scheduled test results
POST {{baseUrl}}/endpoint/test-results/scheduled-tests/:testId/network/filter?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&cursor=
Returns network metrics (loss, latency, and jitter) from each endpoint agent, for each roundId within the specified time window, as determined by search filters. If a time frame is provided, the rounds relevant to that time frame are returned, and the order is not predefined unless the user specifies a sort order in the filter. When no time frame is provided, the latest rounds are returned.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
aid | number | A 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. | |
window | string | A 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. | |||
startDate | string | Use 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. | |
endDate | string | Defaults 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. | |
cursor | null | (Optional) Opaque cursor used for pagination. Clients should use next value from _links instead of this parameter. |
Request Body
{"searchSort"=>[{"sort"=>"round-id", "order"=>"desc"}, {"sort"=>"round-id", "order"=>"desc"}], "thresholdFilter"=>{"filters"=>[{"name"=>"loss", "value"=>10, "operator"=>"gte"}, {"name"=>"loss", "value"=>10, "operator"=>"gte"}], "conditionalOperator"=>"and"}, "searchFilters"=>{"agentId"=>["52455b09-ff1b-4849-8194-99026cc890e0", "52455b09-ff1b-4849-8194-99026cc890e0"]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
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"},"avgLatency":167.04,"errorDetails":"Error","jitter":0.076808,"isIcmpBlocked":true,"loss":0,"maxLatency":168,"minLatency":167},{"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"},"avgLatency":167.04,"errorDetails":"Error","jitter":0.076808,"isIcmpBlocked":true,"loss":0,"maxLatency":168,"minLatency":167}],"totalHits":12,"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":true,"type":"reprehenderit laborum incididunt minim ut","deprecation":"consequat cillum ea exercitation","name":"ullamco commodo aute ex dolor","profile":"minim qui","title":"sint eiusmod laborum","hreflang":"proident dolor ea"}}}