{"type":"api","title":"Retrieve network scheduled test results","meta":{"id":"/apps/pubhub/media/000-v7-apis/2dc5e5bc4da2f77137711dfa43b22ed976ed149e/85928a65-da17-3012-a6df-bb224dd8278a","info":{"title":"Endpoint Test Results API","version":"7.0.86","description":"Retrieve results for scheduled and dynamic tests on endpoint agents."},"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":{"type":"http","scheme":"bearer","description":"Bearer authentication token"}}},"spec":{"tags":["Network Endpoint Scheduled Test Results"],"summary":"Retrieve network scheduled test results","description":"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.\nWhen no time frame is provided, the latest rounds are returned.\n","operationId":"filterScheduledTestNetworkResults","parameters":[{"name":"testId","description":"Test ID","required":true,"in":"path","schema":{"type":"string","example":"202701"},"$$ref":"#/components/parameters/TestIdPath"},{"name":"aid","in":"query","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.","required":false,"schema":{"type":"string","example":"1234"},"$$ref":"#/components/parameters/AccountGroupId"},{"name":"window","in":"query","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`.","schema":{"type":"string","pattern":"^\\d+(?:[smhdw]{1})?$","example":"12h"},"$$ref":"#/components/parameters/Window"},{"name":"startDate","in":"query","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`.","schema":{"type":"string","format":"date-time","example":"2022-07-17T22:00:54Z"},"$$ref":"#/components/parameters/StartDateParameter"},{"name":"endDate","in":"query","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`.","schema":{"type":"string","format":"date-time","example":"2022-07-18T22:00:54Z"},"$$ref":"#/components/parameters/EndDateParameter"},{"name":"cursor","in":"query","example":null,"description":"(Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.","schema":{"type":"string","example":null},"$$ref":"#/components/parameters/PaginationCursor"},{"name":"expand","in":"query","style":"form","explode":false,"description":"This parameter is optional and determines whether to expand resources related to test results. By default, no expansion occurs when this query parameter is omitted. To expand a specific resource, such as \"user-profile,\" append `?expand=user-profile` to the query.","schema":{"type":"array","items":{"type":"string","enum":["user-profile"],"example":"user-profile","$$ref":"#/components/schemas/ExpandEndpointNetworkOptions"},"example":["header"]},"$$ref":"#/components/parameters/ExpandEndpointNetwork"}],"requestBody":{"description":"Tests data search filters.","content":{"application/json":{"schema":{"type":"object","properties":{"searchSort":{"type":"array","items":{"type":"object","properties":{"sort":{"type":"string","enum":["round-id","loss","latency","jitter","cpu","memory","signal-quality"],"example":"round-id","$$ref":"#/components/schemas/EndpointTestsDataSearchSortKey"},"order":{"type":"string","example":"desc","description":"Parameter indicates the ascending/descending order of the sorting, using either the asc or desc values.","enum":["asc","desc"],"$$ref":"#/components/schemas/SortOrder"}},"$$ref":"#/components/schemas/EndpointTestsDataSearchSort"}},"thresholdFilter":{"type":"object","description":"All filters are applied based on the conditional operator (and/or).","properties":{"filters":{"type":"array","items":{"type":"object","description":"The metric is filtered based on the threshold value and operator provided.","properties":{"name":{"type":"string","description":"Metric on which the threshold filter is applied.","enum":["loss","latency","jitter","cpu","memory","signal-quality","application-score","zta-ingress-loss","zta-service-loss","zta-ingress-avg-latency","zta-service-avg-latency","zta-ingress-jitter","zta-service-jitter"],"example":"loss","$$ref":"#/components/schemas/ThresholdFilterName"},"value":{"type":"number","description":"The threshold value.","format":"double","example":10},"operator":{"type":"string","enum":["gte","lte"],"example":"gte","$$ref":"#/components/schemas/ThresholdFilterOperator"}},"$$ref":"#/components/schemas/EndpointTestsDataThresholdFilter"}},"conditionalOperator":{"type":"string","enum":["and","or"],"example":"and","$$ref":"#/components/schemas/ConditionalOperator"}},"$$ref":"#/components/schemas/EndpointTestsDataThresholdFilters"},"searchFilters":{"type":"object","properties":{"agentId":{"description":"Filter using the `agent-id`.","type":"array","items":{"type":"string","format":"uuid","example":"52455b09-ff1b-4849-8194-99026cc890e0"}},"userPrincipalName":{"description":"Filters results based on an array of `userPrincipalName` values.","type":"array","items":{"type":"string","description":"User login name in Internet-style format, typically used in Active Directory environments.","example":"joeblogs32@c.com","$$ref":"#/components/schemas/UserPrincipalName"},"$$ref":"#/components/schemas/UserPrincipalNameFilter"}},"$$ref":"#/components/schemas/EndpointTestsDataSearchFilter"}},"$$ref":"#/components/schemas/EndpointTestsDataRoundsSearch"}}}},"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"type":"object","properties":{"results":{"x-paginated-items":true,"type":"array","items":{"type":"object","properties":{"aid":{"type":"string","description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","$$ref":"#/components/schemas/AccountGroupId"},"testId":{"type":"string","description":"Unique ID of endpoint test.","example":"584739201","readOnly":true,"$$ref":"#/components/schemas/TestId"},"agentId":{"type":"string","format":"uuid","description":"Unique ID of endpoint agent, from `/endpoint/agents` endpoint.","example":"861b7557-cd57-4bbb-b648-00bddf88ef49","readOnly":true,"$$ref":"#/components/schemas/EndpointAgentId"},"roundId":{"type":"integer","description":"Epoch time (seconds) indicating the start time of the round.","example":1384309800,"readOnly":true,"$$ref":"#/components/schemas/RoundId"},"serverIp":{"type":"string","description":"IP address of target server.","example":"185.199.108.153","readOnly":true},"networkProfile":{"type":"object","properties":{"ipAddress":{"type":"string","description":"Network IP address.","example":"10.0.0.13","readOnly":true},"subnetMask":{"type":"string","description":"Network subnet mask - only for IPv4.","example":"255.255.255.0","readOnly":true},"publicIpAddress":{"type":"string","description":"Network public IP address.","example":"84.255.241.1","readOnly":true},"localPrefix":{"type":"string","description":"Network local prefix.","example":"10.0.0.0","readOnly":true},"publicIpRange":{"type":"string","description":"Network public IP range.","example":"84.255.241.0-84.255.241.255","readOnly":true},"dnsServers":{"type":"array","description":"Network DNS servers.","example":["8.8.8.8","8.8.8.4"],"readOnly":true,"items":{"type":"string"}},"hardwareType":{"type":"string","example":"wireless","enum":["unknown","wireless","ethernet","modem","virtual","loopback","other"],"$$ref":"#/components/schemas/InterfaceHardwareType"},"interfaceName":{"type":"string","description":"Network interface name.","example":"en0","readOnly":true},"error":{"type":"string","description":"Only present when there is an error","example":"An operation timed out.","readOnly":true},"gateway":{"type":"string","description":"Network gateway address.","example":"10.0.0.1","readOnly":true},"wirelessProfile":{"type":"object","properties":{"ssid":{"type":"string","description":"Wireless network SSID.","example":"Internet for the masses","readOnly":true},"bssid":{"type":"string","description":"Wireless network BSSID.","example":"4c:ba:ba:f4:fa:fa","readOnly":true},"channel":{"type":"integer","description":"Wireless network channel.","example":1,"readOnly":true},"phyMode":{"type":"string","description":"Wireless network PHY mode.","example":"802.11n","readOnly":true},"rssi":{"type":"integer","description":"Wireless network RSSI.","example":-38,"readOnly":true},"noise":{"type":"integer","description":"Wireless network noise.","example":-95,"readOnly":true},"quality":{"type":"integer","description":"Wireless network quality.","example":100,"readOnly":true},"txRate":{"type":"integer","description":"Wireless network transmitted rate.","example":130,"readOnly":true},"vendor":{"type":"string","description":"Wireless network device vendor.","example":"Cisco","readOnly":true}},"$$ref":"#/components/schemas/NetworkWirelessProfile"},"proxyProfile":{"type":"object","properties":{"method":{"type":"string","description":"Proxy profile method.","example":"System","readOnly":true},"proxies":{"type":"array","items":{"type":"object","properties":{"bypass":{"type":"string","description":"Proxy bypass expression.","example":"*.local;169.254/16","readOnly":true},"proxy":{"type":"string","description":"Proxy mode.","example":"\u003cdirect\u003e","readOnly":true}},"$$ref":"#/components/schemas/NetworkProxy"}}},"$$ref":"#/components/schemas/NetworkProxyProfile"},"ethernetProfile":{"type":"object","properties":{"linkSpeed":{"type":"integer","description":"Ethernet profile link speed","example":860,"readOnly":true}},"$$ref":"#/components/schemas/EndpointTestEthernetProfile"},"previousInterface":{"type":"object","properties":{"ipAddress":{"type":"string","description":"Network IP address.","example":"10.0.0.13","readOnly":true},"subnetMask":{"type":"string","description":"Network subnet mask - only for IPv4.","example":"255.255.255.0","readOnly":true},"publicIpAddress":{"type":"string","description":"Network public IP address.","example":"84.255.241.1","readOnly":true},"localPrefix":{"type":"string","description":"Network local prefix.","example":"10.0.0.0","readOnly":true},"publicIpRange":{"type":"string","description":"Network public IP range.","example":"84.255.241.0-84.255.241.255","readOnly":true},"dnsServers":{"type":"array","description":"Network DNS servers.","example":["8.8.8.8","8.8.8.4"],"readOnly":true,"items":{"type":"string"}},"hardwareType":{"type":"string","example":"wireless","enum":["unknown","wireless","ethernet","modem","virtual","loopback","other"],"$$ref":"#/components/schemas/InterfaceHardwareType"},"interfaceName":{"type":"string","description":"Network interface name.","example":"en0","readOnly":true}},"$$ref":"#/components/schemas/NetworkInterface"}},"$$ref":"#/components/schemas/NetworkProfile","description":"Contains basic network connectivity parameters."},"systemMetrics":{"type":"object","properties":{"startTimeMs":{"type":"integer","format":"int64","description":"The start time of metrics collection, expressed in milliseconds since the Epoch.","example":1581508857327,"readOnly":true},"endTimeMs":{"type":"integer","format":"int64","description":"The end time of metrics collection, expressed in milliseconds since the Epoch.","example":1581508867333,"readOnly":true},"cpuUtilization":{"type":"object","properties":{"min":{"type":"number","format":"double","description":"The minimum sampled usage value recorded during the monitored period.","example":0.22,"minimum":0,"maximum":1,"readOnly":true},"max":{"type":"number","format":"double","description":"The maximum sampled usage value recorded during the monitored period.","example":0.75,"minimum":0,"maximum":1,"readOnly":true},"mean":{"type":"number","format":"double","description":"The mean (average) sampled usage value recorded during the monitored period.","example":0.55,"minimum":0,"maximum":1,"readOnly":true},"median":{"type":"number","format":"double","description":"The median sampled usage value recorded during the monitored period.","example":0.61,"minimum":0,"maximum":1,"readOnly":true},"stdDev":{"type":"number","format":"double","description":"The standard deviation of sampled usage values recorded during the monitored period.","example":0.01,"minimum":0,"maximum":1,"readOnly":true},"count":{"type":"integer","description":"The total number of samples collected during the monitored period.","example":150,"readOnly":true}},"$$ref":"#/components/schemas/CpuUtilization"},"physicalMemoryUsedBytes":{"type":"object","properties":{"min":{"type":"number","format":"double","description":"The minimum sampled memory usage value recorded during the monitored period.","example":1.2,"readOnly":true},"max":{"type":"number","format":"double","description":"The maximum sampled memory usage value recorded during the monitored period.","example":2.5,"readOnly":true},"mean":{"type":"number","format":"double","description":"The mean (average) value of memory usage sampled over the monitored period.","example":1.77,"readOnly":true},"median":{"type":"number","format":"double","description":"The median value of memory usage sampled over the monitored period.","example":1.85,"readOnly":true},"stdDev":{"type":"number","format":"double","description":"The standard deviation of memory usage sampled during the monitored period.","example":0.25,"readOnly":true},"count":{"type":"integer","description":"The total number of samples collected during the monitored period.","example":155,"readOnly":true}},"$$ref":"#/components/schemas/PhysicalMemoryUsedBytes"},"physicalMemoryTotalBytes":{"type":"integer","format":"int64","description":"Total physical memory of the system.","example":1024,"readOnly":true}},"$$ref":"#/components/schemas/SystemMetrics"},"originalTargetProfile":{"type":"object","properties":{"remotePort":{"type":"integer","description":"The remote port of a network flow towards the target.","example":80,"readOnly":true},"remoteIpAddress":{"type":"string","description":"The remote IP address of a network flow towards the target.","example":"120.98.134.7","readOnly":true},"protocol":{"type":"string","enum":["tcp","icmp","udp"],"description":"Protocol used by dependent network tests (end-to-end, path trace, PMTUD).","default":"tcp","example":"tcp","$$ref":"#/components/schemas/TestProtocol"}},"$$ref":"#/components/schemas/TargetProfile"},"userProfile":{"type":"object","description":"Details of the logged-in user, including username and user principal name.","properties":{"userName":{"type":"string","description":"Machine username of the logged-in user.","example":"joeblogs32"},"userPrincipalName":{"type":"string","description":"User login name in Internet-style format, typically used in Active Directory environments.","example":"joeblogs32@c.com","$$ref":"#/components/schemas/UserPrincipalName"}},"$$ref":"#/components/schemas/UserProfile"},"vpnProfile":{"type":"object","properties":{"vpnClientAddresses":{"type":"array","description":"A list of private IP addresses assigned to the device by the VPN server.","example":["184.81.113.85","13.129.91.62"],"readOnly":true,"items":{"type":"string"}},"vpnClientNetworkRange":{"type":"array","description":"A list of private networks assigned to the device by the VPN server.","readOnly":true,"items":{"type":"string","example":"9.88.37.27"}},"vpnGatewayAddress":{"type":"string","description":"IP address of the VPN gateway.","example":"120.98.134.7","readOnly":true},"vpnType":{"type":"string","description":"Name of the VPN provider.","enum":["cisco-anyconnect","palo-alto-globalprotect","ivanti-connect-secure","zscaler-internet-access","f5-big-ip"],"example":"cisco-anyconnect","$$ref":"#/components/schemas/VpnType"}},"$$ref":"#/components/schemas/VpnProfile"},"batteryMetrics":{"description":"Battery metrics for the endpoint agent.","type":"object","readOnly":true,"properties":{"batteryLevel":{"description":"Battery level indicator.","type":"string","example":"medium","enum":["high","medium","low"],"$$ref":"#/components/schemas/BatteryLevel"},"batteryLevelNormalizedPercent":{"type":"number","format":"double","description":"Battery level as a normalized percentage (0-1).","example":0.3,"minimum":0,"maximum":1}},"required":["batteryLevel","batteryLevelNormalizedPercent"],"$$ref":"#/components/schemas/BatteryMetrics"},"cellularProfile":{"description":"Cellular network profile information for a mobile endpoint agent.","type":"object","readOnly":true,"properties":{"carrierName":{"type":"string","description":"Carrier name","example":"T-Mobile"},"networkGen":{"description":"Cellular network generation.","type":"string","example":"2g, 3g, 4g, 5g","$$ref":"#/components/schemas/CellularNetworkGen"},"networkSubtype":{"type":"string","description":"A real network subtype. It may be different from an advertised network type.","example":"LTE/HSPA"},"advertisedNetworkGen":{"description":"Cellular network generation.","type":"string","example":"2g, 3g, 4g, 5g","$$ref":"#/components/schemas/CellularNetworkGen"},"advertisedNetworkSubtype":{"type":"string","description":"Advertised Network subtype","example":"LTE/HSPA"},"rssi":{"type":"number","format":"double","description":"Received Signal Strength Indicator in dBm. Values are always negative.","example":-10},"rsrp":{"type":"number","format":"double","description":"Reference Signal Received Power in dBm. Values are always negative.","example":-30},"rscp":{"type":"number","format":"double","description":"Received Signal Code Power in dBm. Values are always negative or zero.","example":-30},"rsrq":{"type":"number","format":"double","description":"Reference Signal Received Quality in dBm. Values are always negative.","example":-30},"sinr":{"type":"number","format":"double","description":"Signal to Interference and Noise Ratio in dBm. It can be negative or positive.","example":20}},"$$ref":"#/components/schemas/CellularProfile"},"platform":{"description":"OS platform types. Platform \"linux\" was recently renamed to \"roomos\".","type":"string","enum":["windows","roomos","phoneos","elux","cisco-wireless","linux","mac","android","unknown"],"example":"mac","$$ref":"#/components/schemas/Platform"},"avgLatency":{"type":"number","description":"Average RTT for packets sent to destination.","example":167.04,"format":"double","readOnly":true},"errorDetails":{"type":"string","description":"Error details, if an error was encountered.","example":"Error","readOnly":true},"jitter":{"type":"number","description":"Standard deviation of latency.","example":0.076808,"format":"double","readOnly":true},"score":{"type":"object","properties":{"applicationScore":{"type":"number","format":"double","description":"A fine-grained score between 0 and 100.","example":100,"$$ref":"#/components/schemas/EndpointScoreNumeric"},"quality":{"type":"string","enum":["great","good","poor"],"example":"great","$$ref":"#/components/schemas/ApplicationScoreQuality"}},"$$ref":"#/components/schemas/EndpointPingDataPointScore"},"ztaMetrics":{"type":"array","items":{"type":"object","properties":{"loss":{"type":"number","format":"double","description":"Percentage of packets that failed to reach the destination.","example":50},"avgLatency":{"type":"integer","format":"int64","description":"Average latency in milliseconds.","example":3},"jitter":{"type":"integer","format":"int64","description":"Standard deviation of latency in milliseconds.","example":5},"errorMessage":{"type":"string","description":"Error message if an error occurred.","example":"ERR_NAME_NOT_RESOLVED"},"type":{"type":"string","description":"Type of ZTA segment.","enum":["zta_ingress","zta_service"],"example":"zta_service","$$ref":"#/components/schemas/EndpointZtaSegmentType"}},"$$ref":"#/components/schemas/EndpointZtaMetrics"}},"isIcmpBlocked":{"type":"boolean","description":"Set to `true` if network target is blocking ICMP echo (ping) queries.","example":true,"readOnly":true,"$$ref":"#/components/schemas/IcmpBlocked"},"loss":{"type":"number","description":"Percentage of packets not reaching destination.","example":0,"format":"double","readOnly":true},"maxLatency":{"type":"number","description":"Maximum RTT for packets sent to destination.","example":168,"format":"double","readOnly":true},"minLatency":{"type":"number","description":"Minimum RTT for packets sent to destination.","example":167,"format":"double","readOnly":true}},"$$ref":"#/components/schemas/NetworkEndpointTestResult"}},"totalHits":{"description":"Total number of measurements that match the search criteria.","type":"integer","example":12,"$$ref":"#/components/schemas/TotalHits"},"test":{"oneOf":[{"type":"object","required":["type"],"properties":{"aid":{"type":"string","description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","$$ref":"#/components/schemas/AccountGroupId"},"_links":{"type":"object","description":"A list of links that can be accessed to get more information.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","example":{"href":"https://api.thousandeyes.com/v7/endpoint/tests/{type}/281474976710706"},"type":"object","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/EndpointTestSelfLink"},"testResults":{"type":"array","description":"Reference to the test results.","items":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"},"example":[{"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"}],"$$ref":"#/components/schemas/ScheduledTestResults"}},"readOnly":true,"$$ref":"#/components/schemas/EndpointTestLinks"},"agentSelectorConfig":{"type":"object","description":"Agents selection object based on agentSelectorType.","readOnly":true,"oneOf":[{"type":"object","description":"Any agent selection object.","readOnly":true,"properties":{"agentSelectorType":{"example":"all-agents","pattern":"^all-agents$","type":"string"},"maxMachines":{"type":"integer","description":"Maximum number of agents which can execute the test.","default":25,"example":25,"$$ref":"#/components/schemas/EndpointTestMaxMachines"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointAllAgentsSelectorConfig"},{"type":"object","description":"Agent labels selection object.","readOnly":true,"properties":{"agentSelectorType":{"example":"agent-labels","pattern":"^agent-labels$","type":"string"},"maxMachines":{"type":"integer","description":"Maximum number of agents which can execute the test.","default":25,"example":25,"$$ref":"#/components/schemas/EndpointTestMaxMachines"},"endpointAgentLabels":{"type":"array","description":"List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is set to `agent-labels`.","items":{"type":"string"},"example":["567","214"],"$$ref":"#/components/schemas/EndpointAgentLabels"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointAgentLabelsSelectorConfig"},{"type":"object","description":"Specific agents selection object.","readOnly":true,"properties":{"agentSelectorType":{"type":"string","pattern":"^specific-agents$","example":"specific-agents"},"maxMachines":{"type":"integer","description":"Maximum number of agents which can execute the test.","default":25,"example":25,"$$ref":"#/components/schemas/EndpointTestMaxMachines"},"agents":{"type":"array","description":"List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType` is set to `specific-agent`.","items":{"type":"string","format":"uuid"},"example":["0a3b9998-dc3a-4ff2-b50d-ac4a7cd986e1","66eec0f1-72b4-4755-aa83-3aed61d17f3c"],"$$ref":"#/components/schemas/EndpointTestAgents"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointSpecificAgentsSelectorConfig"}],"discriminator":{"propertyName":"agentSelectorType","mapping":{"all-agents":"#/components/schemas/EndpointAllAgentsSelectorConfig","specific-agents":"#/components/schemas/EndpointSpecificAgentsSelectorConfig","agent-labels":"#/components/schemas/EndpointAgentLabelsSelectorConfig"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointAgentSelectorConfig"},"createdDate":{"type":"string","format":"date-time","description":"UTC created date (ISO date-time format).","example":"2022-07-17T22:00:54Z","readOnly":true,"$$ref":"#/components/schemas/TestCreatedDate"},"isPrioritized":{"type":"boolean","description":"Indicates whether the test should be prioritized when the number of tests assigned to an agent exceeds the license limit.","default":false,"example":false,"$$ref":"#/components/schemas/TestIsPrioritized"},"interval":{"type":"integer","enum":[60,120,300,600,900,1800,3600],"description":"Interval between test runs in seconds.","default":60,"example":60,"$$ref":"#/components/schemas/TestInterval"},"isEnabled":{"type":"boolean","description":"Indicates if test is enabled.","example":true,"default":true,"$$ref":"#/components/schemas/TestIsEnabled"},"isSavedEvent":{"type":"boolean","description":"Indicates if the test is a saved event.\n\n**Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect API.\n","example":false,"readOnly":true,"$$ref":"#/components/schemas/TestIsSavedEvent"},"hasPathTraceInSession":{"type":"boolean","description":"Enables \"in session\" path trace. When enabled, this option initiates a TCP session with the target server and sends path trace packets within the established TCP session.","example":true,"$$ref":"#/components/schemas/TestHasPathTraceInSession"},"labels":{"type":"array","description":"Labels to which the test is assigned. This field is not returned for Instant Tests.","readOnly":true,"items":{"type":"object","properties":{"labelId":{"type":"string","description":"Label ID."},"name":{"type":"string","description":"Name of the label."},"isBuiltin":{"type":"boolean","description":"Value indicating if the label in question is BuiltIn (Account Admin, Organization Admin, Regular User)."}},"example":{"labelId":"961","name":"Artem label","isBuiltin":false},"$$ref":"#/components/schemas/TestLabel"},"$$ref":"#/components/schemas/TestLabels"},"modifiedDate":{"type":"string","format":"date-time","description":"UTC last modification date (ISO date-time format).","readOnly":true,"example":"2022-07-17T22:00:54Z"},"networkMeasurements":{"type":"boolean","description":"Enable or disable network measurements. Set to true to enable or false to disable network measurements.","default":true,"example":true,"$$ref":"#/components/schemas/TestNetworkMeasurements"},"protocol":{"type":"string","enum":["icmp","icmp-with-tcp-connect","tcp","prefer-tcp","ast-autodetect","autodetect"],"description":"Protocol requested for the test.","default":"icmp","example":"icmp","$$ref":"#/components/schemas/EndpointTestProtocol"},"ipVersion":{"description":"For reading current network test configurations, the IP version of the test. Values include V4_ONLY, V6_ONLY, V6_PREFER, and OS_DEFAULT.","type":"string","example":"V4_ONLY","$$ref":"#/components/schemas/EndpointIpVersionOut"},"server":{"type":"string","description":"Target domain name or IP address.","example":"www.example.com"},"testId":{"type":"string","description":"Each test is assigned a unique ID to access test data from other endpoints.","readOnly":true,"example":"281474976710706"},"testName":{"type":"string","description":"Name of the test.","example":"Test name","$$ref":"#/components/schemas/TestName"},"type":{"type":"string","enum":["agent-to-server","http-server"],"description":"Type of test being queried.","example":"agent-to-server","readOnly":true,"$$ref":"#/components/schemas/EndpointAgentToServerType","pattern":"^agent-to-server$"},"tcpProbeMode":{"type":"string","enum":["auto","sack","syn","syn-pcap","syn-socket","unknown"],"description":"Probe mode returned by network test APIs, only valid when the protocol is set to TCP. Configuration responses return user-selectable values, while result responses may also return resolved driver values.","default":"auto","example":"auto","$$ref":"#/components/schemas/TestProbeModeResponse"},"port":{"type":"integer","description":"Port number.","default":443,"example":443,"$$ref":"#/components/schemas/EndpointTestPort"}},"$$ref":"#/components/schemas/EndpointAgentToServerTest"},{"type":"object","required":["type"],"properties":{"aid":{"type":"string","description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","$$ref":"#/components/schemas/AccountGroupId"},"_links":{"type":"object","description":"A list of links that can be accessed to get more information.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","example":{"href":"https://api.thousandeyes.com/v7/endpoint/tests/{type}/281474976710706"},"type":"object","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/EndpointTestSelfLink"},"testResults":{"type":"array","description":"Reference to the test results.","items":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"},"example":[{"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"}],"$$ref":"#/components/schemas/ScheduledTestResults"}},"readOnly":true,"$$ref":"#/components/schemas/EndpointTestLinks"},"agentSelectorConfig":{"type":"object","description":"Agents selection object based on agentSelectorType.","readOnly":true,"oneOf":[{"type":"object","description":"Any agent selection object.","readOnly":true,"properties":{"agentSelectorType":{"example":"all-agents","pattern":"^all-agents$","type":"string"},"maxMachines":{"type":"integer","description":"Maximum number of agents which can execute the test.","default":25,"example":25,"$$ref":"#/components/schemas/EndpointTestMaxMachines"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointAllAgentsSelectorConfig"},{"type":"object","description":"Agent labels selection object.","readOnly":true,"properties":{"agentSelectorType":{"example":"agent-labels","pattern":"^agent-labels$","type":"string"},"maxMachines":{"type":"integer","description":"Maximum number of agents which can execute the test.","default":25,"example":25,"$$ref":"#/components/schemas/EndpointTestMaxMachines"},"endpointAgentLabels":{"type":"array","description":"List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is set to `agent-labels`.","items":{"type":"string"},"example":["567","214"],"$$ref":"#/components/schemas/EndpointAgentLabels"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointAgentLabelsSelectorConfig"},{"type":"object","description":"Specific agents selection object.","readOnly":true,"properties":{"agentSelectorType":{"type":"string","pattern":"^specific-agents$","example":"specific-agents"},"maxMachines":{"type":"integer","description":"Maximum number of agents which can execute the test.","default":25,"example":25,"$$ref":"#/components/schemas/EndpointTestMaxMachines"},"agents":{"type":"array","description":"List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType` is set to `specific-agent`.","items":{"type":"string","format":"uuid"},"example":["0a3b9998-dc3a-4ff2-b50d-ac4a7cd986e1","66eec0f1-72b4-4755-aa83-3aed61d17f3c"],"$$ref":"#/components/schemas/EndpointTestAgents"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointSpecificAgentsSelectorConfig"}],"discriminator":{"propertyName":"agentSelectorType","mapping":{"all-agents":"#/components/schemas/EndpointAllAgentsSelectorConfig","specific-agents":"#/components/schemas/EndpointSpecificAgentsSelectorConfig","agent-labels":"#/components/schemas/EndpointAgentLabelsSelectorConfig"}},"required":["agentSelectorType"],"$$ref":"#/components/schemas/EndpointAgentSelectorConfig"},"createdDate":{"type":"string","format":"date-time","description":"UTC created date (ISO date-time format).","example":"2022-07-17T22:00:54Z","readOnly":true,"$$ref":"#/components/schemas/TestCreatedDate"},"isPrioritized":{"type":"boolean","description":"Indicates whether the test should be prioritized when the number of tests assigned to an agent exceeds the license limit.","default":false,"example":false,"$$ref":"#/components/schemas/TestIsPrioritized"},"interval":{"type":"integer","enum":[60,120,300,600,900,1800,3600,60,120,300,600,900,1800,3600],"description":"Interval between test runs in seconds.","default":60,"example":60,"$$ref":"#/components/schemas/TestInterval"},"isEnabled":{"type":"boolean","description":"Indicates if test is enabled.","example":true,"default":true,"$$ref":"#/components/schemas/TestIsEnabled"},"isSavedEvent":{"type":"boolean","description":"Indicates if the test is a saved event.\n\n**Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect API.\n","example":false,"readOnly":true,"$$ref":"#/components/schemas/TestIsSavedEvent"},"hasPathTraceInSession":{"type":"boolean","description":"Enables \"in session\" path trace. When enabled, this option initiates a TCP session with the target server and sends path trace packets within the established TCP session.","example":true,"$$ref":"#/components/schemas/TestHasPathTraceInSession"},"labels":{"type":"array","description":"Labels to which the test is assigned. This field is not returned for Instant Tests.","readOnly":true,"items":{"type":"object","properties":{"labelId":{"type":"string","description":"Label ID."},"name":{"type":"string","description":"Name of the label."},"isBuiltin":{"type":"boolean","description":"Value indicating if the label in question is BuiltIn (Account Admin, Organization Admin, Regular User)."}},"example":{"labelId":"961","name":"Artem label","isBuiltin":false},"$$ref":"#/components/schemas/TestLabel"},"$$ref":"#/components/schemas/TestLabels"},"modifiedDate":{"type":"string","format":"date-time","description":"UTC last modification date (ISO date-time format).","readOnly":true,"example":"2022-07-17T22:00:54Z"},"networkMeasurements":{"type":"boolean","description":"Enable or disable network measurements. Set to true to enable or false to disable network measurements.","default":true,"example":true,"$$ref":"#/components/schemas/TestNetworkMeasurements"},"protocol":{"type":"string","enum":["icmp","icmp-with-tcp-connect","tcp","prefer-tcp","ast-autodetect","autodetect","icmp","icmp-with-tcp-connect","tcp","prefer-tcp","ast-autodetect","autodetect"],"description":"Protocol requested for the test.","default":"icmp","example":"icmp","$$ref":"#/components/schemas/EndpointTestProtocol"},"ipVersion":{"description":"For reading current network test configurations, the IP version of the test. Values include V4_ONLY, V6_ONLY, V6_PREFER, and OS_DEFAULT.","type":"string","example":"V4_ONLY","$$ref":"#/components/schemas/EndpointIpVersionOut"},"server":{"type":"string","description":"Target domain name or IP address.","example":"www.example.com"},"testId":{"type":"string","description":"Each test is assigned a unique ID to access test data from other endpoints.","readOnly":true,"example":"281474976710706"},"testName":{"type":"string","description":"Name of the test.","example":"Test name","$$ref":"#/components/schemas/TestName"},"type":{"type":"string","enum":["agent-to-server","http-server"],"description":"Type of test being queried.","example":"http-server","readOnly":true,"$$ref":"#/components/schemas/EndpointHttpServerType","pattern":"^http-server$"},"tcpProbeMode":{"type":"string","enum":["auto","sack","syn","syn-pcap","syn-socket","unknown","auto","sack","syn","syn-pcap","syn-socket","unknown"],"description":"Probe mode returned by network test APIs, only valid when the protocol is set to TCP. Configuration responses return user-selectable values, while result responses may also return resolved driver values.","default":"auto","example":"auto","$$ref":"#/components/schemas/TestProbeModeResponse"},"port":{"type":"integer","description":"Port number.","default":443,"example":443,"$$ref":"#/components/schemas/EndpointTestPort"},"authType":{"type":"string","description":"HTTP authentication type.","enum":["none","basic","ntlm"],"default":"none","example":"none","$$ref":"#/components/schemas/EndpointTestAuthType"},"httpTimeLimit":{"type":"integer","description":"Maximum amount of time in milliseconds the agents wait before a request times out.","default":5000,"example":5000},"username":{"type":"string","description":"Username for Basic/NTLM authentication.","example":"username","$$ref":"#/components/schemas/TestUsername"},"sslVersionId":{"type":"string","description":"SSL version options:\n\n* Use '0' for automatic selection.\n* Use '3' for SSLv3.\n* Use '4' for TLS v1.0.\n* Use '5' for TLS v1.1.\n* Use '6' for TLS v1.2.\n* Use '7' for TLS v1.3.\n","enum":["0","3","4","5","6","7"],"default":"0","example":"0","$$ref":"#/components/schemas/TestSslVersionId"},"verifyCertificate":{"type":"boolean","description":"Flag indicating if a certificate should be verified.","default":true,"example":true},"url":{"type":"string","description":"The test target URL.","example":"https://example.com:443","$$ref":"#/components/schemas/EndpointTestResultUrl"},"followRedirects":{"type":"boolean","description":"To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`.","default":true,"example":true,"$$ref":"#/components/schemas/TestFollowRedirects"},"httpTargetTime":{"type":"integer","minimum":100,"maximum":5000,"description":"Target time for HTTP server completion, specified in milliseconds.","example":100,"$$ref":"#/components/schemas/TestHttpTargetTime"},"httpVersion":{"type":"integer","minimum":1,"maximum":2,"description":"HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1.","default":2,"example":2,"$$ref":"#/components/schemas/TestHttpVersion"},"sslVersion":{"type":"string","description":"Reflects the verbose SSL protocol version used by a test.","readOnly":true,"example":"Auto","$$ref":"#/components/schemas/TestSslVersion"},"useNtlm":{"type":"boolean","description":"Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set.","example":false,"$$ref":"#/components/schemas/TestUseNtlm"}},"$$ref":"#/components/schemas/EndpointHttpServerTest"}],"discriminator":{"propertyName":"type","mapping":{"agent-to-server":"#/components/schemas/EndpointAgentToServerTest","http-server":"#/components/schemas/EndpointHttpServerTest"}},"$$ref":"#/components/schemas/EndpointScheduledTest"},"startDate":{"type":"string","format":"date-time","example":"2022-07-17T22:00:54Z","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).","readOnly":true,"$$ref":"#/components/schemas/StartDate"},"endDate":{"type":"string","format":"date-time","example":"2022-07-18T22:00:54Z","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).","readOnly":true,"$$ref":"#/components/schemas/EndDate"},"_links":{"type":"object","description":"A links object containing a related link for forward pagination.","properties":{"next":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/PaginationNextLink"}},"$$ref":"#/components/schemas/NetworkEndpointTestResults"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"invalid_token"},"error_description":{"type":"string","example":"Invalid access token"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/401"},"403":{"description":"Insufficient permissions to query endpoint","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/403"},"404":{"description":"Not found","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"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"}}},"$$ref":"#/components/responses/404"},"429":{"description":"Exhausted rate limit for the organization","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/429"},"500":{"description":"Internal server error","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"}}},"$$ref":"#/components/responses/500"},"502":{"description":"Bad Gateway","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/502"}},"__originalOperationId":"filterScheduledTestNetworkResults","security":[{"BearerAuth":[]}],"method":"post","path":"/endpoint/test-results/scheduled-tests/{testId}/network/filter"}}