{"type":"api","title":"Retrieve network scheduled test results from multiple tests","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/85928a65-da17-3012-a6df-bb224dd8278a","info":{"description":"Retrieve results for scheduled and dynamic tests on endpoint agents.","title":"Endpoint Test Results API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"name":"Network Endpoint Scheduled Test Results"},{"name":"HTTP Server Endpoint Scheduled Test Results"},{"name":"Network Dynamic Endpoint Test Results"},{"name":"Real User Endpoint Test Results"},{"name":"Local Network Endpoint Test Results"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"description":"Returns network metrics, including loss, latency, and jitter, for multiple test IDs obtained from each endpoint agent. It allows you to specify a time window using search filters to retrieve metrics for specific round IDs within that time frame. The default order of results is unspecified unless you include a sorting preference in the filter.\nWhen no time frame is provided, the API returns metrics for the most recent rounds. Access to all accounts associated with the specified test IDs is required to use this endpoint.\n","operationId":"filterScheduledTestsNetworkResults","parameters":[{"description":"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.","in":"query","name":"aid","required":false,"schema":{"example":"1234","type":"string"}},{"description":"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.\nFor a precise date range, use `startDate` and `endDate`.","in":"query","name":"window","schema":{"example":"12h","pattern":"^\\d+(?:[smhdw]{1})?$","type":"string"}},{"description":"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`.","in":"query","name":"startDate","schema":{"example":"2022-07-17T22:00:54Z","format":"date-time","type":"string"}},{"description":"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`.","in":"query","name":"endDate","schema":{"example":"2022-07-18T22:00:54Z","format":"date-time","type":"string"}},{"description":"(Optional) Maximum number of objects to return.","in":"query","name":"max","schema":{"example":5,"type":"integer"}},{"description":"(Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.","in":"query","name":"cursor","schema":{"type":"string","example":null}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"searchSort":{"items":{"properties":{"sort":{"enum":["round-id","loss","latency","jitter","cpu","memory","signal-quality"],"example":"round-id","type":"string","$$ref":"#/components/schemas/EndpointTestsDataSearchSortKey"},"order":{"description":"Parameter indicates the ascending/descending order of the sorting, using either the asc or desc values.","enum":["asc","desc"],"example":"desc","type":"string","$$ref":"#/components/schemas/SortOrder"}},"type":"object","$$ref":"#/components/schemas/EndpointTestsDataSearchSort"},"type":"array"},"thresholdFilter":{"description":"All filters are applied based on the conditional operator (and/or).","properties":{"filters":{"items":{"description":"The metric is filtered based on the threshold value and operator provided.","properties":{"name":{"description":"Metric on which the threshold filter is applied.","enum":["loss","latency","jitter","cpu","memory","signal-quality"],"example":"loss","type":"string","$$ref":"#/components/schemas/ThresholdFilterName"},"value":{"description":"The threshold value.","example":10,"format":"double","type":"number"},"operator":{"enum":["gte","lte"],"example":"gte","type":"string","$$ref":"#/components/schemas/ThresholdFilterOperator"}},"type":"object","$$ref":"#/components/schemas/EndpointTestsDataThresholdFilter"},"type":"array"},"conditionalOperator":{"enum":["and","or"],"example":"and","type":"string","$$ref":"#/components/schemas/ConditionalOperator"}},"type":"object","$$ref":"#/components/schemas/EndpointTestsDataThresholdFilters"},"searchFilters":{"properties":{"agentId":{"description":"Filter using the `agent-id`.","items":{"example":"52455b09-ff1b-4849-8194-99026cc890e0","format":"uuid","type":"string"},"type":"array"},"testId":{"items":{"example":"5","type":"string"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/MultiTestIdEndpointTestsDataSearchFilter"}},"type":"object","$$ref":"#/components/schemas/MultiTestIdEndpointTestsDataRoundsSearch"}}},"description":"Test data search filters."},"responses":{"200":{"content":{"application/hal+json":{"schema":{"properties":{"results":{"items":{"properties":{"aid":{"description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","type":"string"},"testId":{"description":"Unique ID of endpoint test.","example":"584739201","readOnly":true,"type":"string"},"agentId":{"description":"Unique ID of endpoint agent, from `/endpoint/agents` endpoint.","example":"861b7557-cd57-4bbb-b648-00bddf88ef49","format":"uuid","readOnly":true,"type":"string"},"roundId":{"description":"Epoch time (seconds) indicating the start time of the round.","example":1384309800,"readOnly":true,"type":"integer"},"serverIp":{"description":"IP address of target server.","example":"185.199.108.153","readOnly":true,"type":"string"},"networkProfile":{"properties":{"ipAddress":{"description":"Network IP address.","example":"10.0.0.13","readOnly":true,"type":"string"},"subnetMask":{"description":"Network subnet mask - only for IPv4.","example":"255.255.255.0","readOnly":true,"type":"string"},"publicIpAddress":{"description":"Network public IP address.","example":"84.255.241.1","readOnly":true,"type":"string"},"localPrefix":{"description":"Network local prefix.","example":"10.0.0.0","readOnly":true,"type":"string"},"publicIpRange":{"description":"Network public IP range.","example":"84.255.241.0-84.255.241.255","readOnly":true,"type":"string"},"dnsServers":{"description":"Network DNS servers.","example":["8.8.8.8","8.8.8.4"],"items":{"type":"string"},"readOnly":true,"type":"array"},"hardwareType":{"enum":["unknown","wireless","ethernet","modem","virtual","loopback","other"],"example":"wireless","type":"string","$$ref":"#/components/schemas/InterfaceHardwareType"},"interfaceName":{"description":"Network interface name.","example":"en0","readOnly":true,"type":"string"},"error":{"description":"Only present when there is an error","example":"An operation timed out.","readOnly":true,"type":"string"},"gateway":{"description":"Network gateway address.","example":"10.0.0.1","readOnly":true,"type":"string"},"wirelessProfile":{"properties":{"ssid":{"description":"Wireless network SSID.","example":"Internet for the masses","readOnly":true,"type":"string"},"bssid":{"description":"Wireless network BSSID.","example":"4c:ba:ba:f4:fa:fa","readOnly":true,"type":"string"},"channel":{"description":"Wireless network channel.","example":1,"readOnly":true,"type":"integer"},"phyMode":{"description":"Wireless network PHY mode.","example":"802.11n","readOnly":true,"type":"string"},"rssi":{"description":"Wireless network RSSI.","example":-38,"readOnly":true,"type":"integer"},"noise":{"description":"Wireless network noise.","example":-95,"readOnly":true,"type":"integer"},"quality":{"description":"Wireless network quality.","example":100,"readOnly":true,"type":"integer"},"txRate":{"description":"Wireless network transmitted rate.","example":130,"readOnly":true,"type":"integer"},"vendor":{"description":"Wireless network device vendor.","example":"Cisco","readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/NetworkWirelessProfile"},"proxyProfile":{"properties":{"method":{"description":"Proxy profile method.","example":"System","readOnly":true,"type":"string"},"proxies":{"items":{"properties":{"bypass":{"description":"Proxy bypass expression.","example":"*.local;169.254/16","readOnly":true,"type":"string"},"proxy":{"description":"Proxy mode.","example":"\u003cdirect\u003e","readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/NetworkProxy"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/NetworkProxyProfile"},"ethernetProfile":{"properties":{"linkSpeed":{"description":"Ethernet profile link speed","example":860,"readOnly":true,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/EndpointTestEthernetProfile"},"previousInterface":{"properties":{"ipAddress":{"description":"Network IP address.","example":"10.0.0.13","readOnly":true,"type":"string"},"subnetMask":{"description":"Network subnet mask - only for IPv4.","example":"255.255.255.0","readOnly":true,"type":"string"},"publicIpAddress":{"description":"Network public IP address.","example":"84.255.241.1","readOnly":true,"type":"string"},"localPrefix":{"description":"Network local prefix.","example":"10.0.0.0","readOnly":true,"type":"string"},"publicIpRange":{"description":"Network public IP range.","example":"84.255.241.0-84.255.241.255","readOnly":true,"type":"string"},"dnsServers":{"description":"Network DNS servers.","example":["8.8.8.8","8.8.8.4"],"items":{"type":"string"},"readOnly":true,"type":"array"},"hardwareType":{"enum":["unknown","wireless","ethernet","modem","virtual","loopback","other"],"example":"wireless","type":"string","$$ref":"#/components/schemas/InterfaceHardwareType"},"interfaceName":{"description":"Network interface name.","example":"en0","readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/NetworkInterface"}},"type":"object","$$ref":"#/components/schemas/NetworkProfile","description":"Contains basic network connectivity parameters."},"systemMetrics":{"properties":{"startTimeMs":{"description":"The start time of metrics collection, expressed in milliseconds since the Epoch.","example":1581508857327,"format":"int64","readOnly":true,"type":"integer"},"endTimeMs":{"description":"The end time of metrics collection, expressed in milliseconds since the Epoch.","example":1581508867333,"format":"int64","readOnly":true,"type":"integer"},"cpuUtilization":{"properties":{"min":{"description":"The minimum sampled usage value recorded during the monitored period.","example":0.22,"format":"double","maximum":1,"minimum":0,"readOnly":true,"type":"number"},"max":{"description":"The maximum sampled usage value recorded during the monitored period.","example":0.75,"format":"double","maximum":1,"minimum":0,"readOnly":true,"type":"number"},"mean":{"description":"The mean (average) sampled usage value recorded during the monitored period.","example":0.55,"format":"double","maximum":1,"minimum":0,"readOnly":true,"type":"number"},"median":{"description":"The median sampled usage value recorded during the monitored period.","example":0.61,"format":"double","maximum":1,"minimum":0,"readOnly":true,"type":"number"},"stdDev":{"description":"The standard deviation of sampled usage values recorded during the monitored period.","example":0.01,"format":"double","maximum":1,"minimum":0,"readOnly":true,"type":"number"},"count":{"description":"The total number of samples collected during the monitored period.","example":150,"readOnly":true,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/CpuUtilization"},"physicalMemoryUsedBytes":{"properties":{"min":{"description":"The minimum sampled memory usage value recorded during the monitored period.","example":1.2,"format":"double","readOnly":true,"type":"number"},"max":{"description":"The maximum sampled memory usage value recorded during the monitored period.","example":2.5,"format":"double","readOnly":true,"type":"number"},"mean":{"description":"The mean (average) value of memory usage sampled over the monitored period.","example":1.77,"format":"double","readOnly":true,"type":"number"},"median":{"description":"The median value of memory usage sampled over the monitored period.","example":1.85,"format":"double","readOnly":true,"type":"number"},"stdDev":{"description":"The standard deviation of memory usage sampled during the monitored period.","example":0.25,"format":"double","readOnly":true,"type":"number"},"count":{"description":"The total number of samples collected during the monitored period.","example":155,"readOnly":true,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/PhysicalMemoryUsedBytes"},"physicalMemoryTotalBytes":{"description":"Total physical memory of the system.","example":1024,"format":"int64","readOnly":true,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/SystemMetrics"},"originalTargetProfile":{"properties":{"remotePort":{"description":"The remote port of a network flow towards the target.","example":80,"readOnly":true,"type":"integer"},"remoteIpAddress":{"description":"The remote IP address of a network flow towards the target.","example":"120.98.134.7","readOnly":true,"type":"string"},"protocol":{"default":"tcp","description":"Protocol used by dependent network tests (end-to-end, path trace, PMTUD).","enum":["tcp","icmp","udp"],"example":"tcp","type":"string","$$ref":"#/components/schemas/TestProtocol"}},"type":"object","$$ref":"#/components/schemas/TargetProfile"},"vpnProfile":{"properties":{"vpnClientAddresses":{"description":"A list of private IP addresses assigned to the device by the VPN server.","example":["184.81.113.85","13.129.91.62"],"items":{"type":"string"},"readOnly":true,"type":"array"},"vpnClientNetworkRange":{"description":"A list of private networks assigned to the device by the VPN server.","items":{"example":"9.88.37.27","type":"string"},"readOnly":true,"type":"array"},"vpnGatewayAddress":{"description":"IP address of the VPN gateway.","example":"120.98.134.7","readOnly":true,"type":"string"},"vpnType":{"description":"Name of the VPN provider.","enum":["cisco-anyconnect","palo-alto-globalprotect","ivanti-connect-secure","zscaler-internet-access","f5-big-ip"],"example":"cisco-anyconnect","type":"string","$$ref":"#/components/schemas/VpnType"}},"type":"object","$$ref":"#/components/schemas/VpnProfile"},"avgLatency":{"description":"Average RTT for packets sent to destination.","example":167.04,"format":"double","readOnly":true,"type":"number"},"errorDetails":{"description":"Error details, if an error was encountered.","example":"Error","readOnly":true,"type":"string"},"jitter":{"description":"Standard deviation of latency.","example":0.076808,"format":"double","readOnly":true,"type":"number"},"isIcmpBlocked":{"description":"Set to `true` if network target is blocking ICMP echo (ping) queries.","example":true,"readOnly":true,"type":"boolean","$$ref":"#/components/schemas/IcmpBlocked"},"loss":{"description":"Percentage of packets not reaching destination.","example":0,"format":"double","readOnly":true,"type":"number"},"maxLatency":{"description":"Maximum RTT for packets sent to destination.","example":168,"format":"double","readOnly":true,"type":"number"},"minLatency":{"description":"Minimum RTT for packets sent to destination.","example":167,"format":"double","readOnly":true,"type":"number"}},"type":"object","$$ref":"#/components/schemas/NetworkEndpointTestResult"},"type":"array","x-paginated-items":true},"totalHits":{"description":"Total number of measurements that match the search criteria.","example":12,"type":"integer"},"startDate":{"description":"(Optional) When passing `window` or `startDate` parameter, the client will also receive the `startDate` field indicating the UTC start date of the data's time range being retrieved (ISO date-time format).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"endDate":{"description":"(Optional) When passing `window` or `endDate` parameter, the client will also receive the `endDate` field indicating the UTC end date of the data's time range being retrieved (ISO date-time format).","example":"2022-07-18T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"_links":{"description":"A links object containing a related link for forward pagination.","properties":{"next":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"type":"object","$$ref":"#/components/schemas/PaginationNextLink"}},"type":"object","$$ref":"#/components/schemas/MultiTestIdNetworkEndpointTestResults"}}},"description":"OK"},"401":{"content":{"application/problem+json":{"schema":{"properties":{"error":{"example":"invalid_token","type":"string"},"error_description":{"example":"Invalid access token","type":"string"}},"type":"object","$$ref":"#/components/schemas/UnauthorizedError"}}},"description":"Unauthorized"},"403":{"content":{"application/problem+json":{"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Insufficient permissions to query endpoint"},"404":{"content":{"application/problem+json":{"example":{"type":"about:blank","title":"URI Resource Not Found","status":404,"detail":"Details explaining if the 404 error is related to an invalid URI or a wrong ID","instance":"/v7"},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Not found"},"429":{"content":{"application/problem+json":{"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Exhausted rate limit for the organization"},"500":{"content":{"application/problem+json":{"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Internal server error"},"502":{"content":{"application/problem+json":{"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Bad Gateway"}},"summary":"Retrieve network scheduled test results from multiple tests","tags":["Network Endpoint Scheduled Test Results"],"__originalOperationId":"filterScheduledTestsNetworkResults","security":[{"BearerAuth":[]}],"method":"post","path":"/endpoint/test-results/scheduled-tests/network/filter"}}