Retrieve network dynamic test results - ThousandEyes API v7

{"type":"api","title":"Retrieve network dynamic test results","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 (`loss`, `latency`, `jitter` and `bandwidth`) from each endpoint agent, for each `roundId` in the requested window. When Time Frame is provided the rounds specific to the time frame is returned and the order is not pre-defined unless a user specifies the sort order in filter. When no time frame is provided the latest rounds are returned.\n","operationId":"filterDynamicTestNetworkResults","parameters":[{"description":"Test ID","in":"path","name":"testId","required":true,"schema":{"example":"202701","type":"string"}},{"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) 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"},"webexConferenceId":{"description":"Filter using the `conference-id` of the webex call.","items":{"example":"52455b09-ff1b-4849-8194-99026cc890e0","format":"uuid","type":"string"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/DynamicEndpointTestsDataSearchFilter"}},"type":"object","$$ref":"#/components/schemas/DynamicEndpointTestsDataRoundSearch"}}},"description":"Tests 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"},"application":{"description":"Which supported application to monitor, can be one of `webex`, `zoom`, `microsoft-teams`.","example":"webex","type":"string"},"protocol":{"default":"unknown","description":"Protocol used to perform the test.","enum":["icmp","tcp","udp","prefer-tcp","ast-autodetect","autodetect","unknown"],"example":"tcp","type":"string","$$ref":"#/components/schemas/EndpointTestResultProtocol"},"tcpProbeMode":{"default":"auto","description":"Probe mode used by network test, only valid when the protocol is set to TCP.","enum":["auto","sack","syn","unknown"],"example":"auto","type":"string","$$ref":"#/components/schemas/TestProbeModeResponse"},"udpProbeMode":{"default":"unknown","description":"Probe mode used by network test, only valid when the protocol is set to UDP.","enum":["stun-pcap","unknown"],"example":"unknown","readOnly":true,"type":"string","$$ref":"#/components/schemas/UdpProbeModeResponse"},"webex":{"description":"Contains object with webex information. Only returned for webex applications.","properties":{"conferenceId":{"description":"Webex conference ID.","example":"225817074608419375","readOnly":true,"type":"string"},"correlationId":{"description":"Webex conference correlation ID.","example":"22581707460321454","readOnly":true,"type":"string"},"localSipSessionId":{"description":"Webex calling local sip session ID.","example":"22581707460321454","readOnly":true,"type":"string"},"remoteSipSessionId":{"description":"Webex calling remote sip session ID.","example":"22581707460321454","readOnly":true,"type":"string"}},"type":"object","$$ref":"#/components/schemas/DynamicEndpointTestWebex"}},"type":"object","$$ref":"#/components/schemas/NetworkDynamicEndpointTestResult"},"type":"array","x-paginated-items":true},"test":{"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"},"_links":{"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/dynamic-tests/agent-to-server/281474976710706"},"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/DynamicTestSelfLink"},"testResults":{"description":"Reference to the test results.","example":[{"href":"https://api.thousandeyes.com/v7/endpoint/test-results/dynamic-tests/281474976710706/network/filter"},{"href":"https://api.thousandeyes.com/v7/endpoint/test-results/dynamic-tests/281474976710706/pathvis"}],"items":{"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":"array"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/DynamicTestLinks"},"agentSelectorConfig":{"description":"Agents selection object based on agentSelectorType.","discriminator":{"mapping":{"all-agents":"#/components/schemas/EndpointAllAgentsSelectorConfig","specific-agents":"#/components/schemas/EndpointSpecificAgentsSelectorConfig","agent-labels":"#/components/schemas/EndpointAgentLabelsSelectorConfig"},"propertyName":"agentSelectorType"},"oneOf":[{"description":"Any agent selection object.","properties":{"agentSelectorType":{"example":"all-agents","pattern":"^all-agents$","type":"string"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer"}},"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointAllAgentsSelectorConfig"},{"description":"Agent labels selection object.","properties":{"agentSelectorType":{"example":"agent-labels","pattern":"^agent-labels$","type":"string"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer"},"endpointAgentLabels":{"description":"List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is set to `agent-labels`.","example":["567","214"],"items":{"type":"string"},"type":"array"}},"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointAgentLabelsSelectorConfig"},{"description":"Specific agents selection object.","properties":{"agentSelectorType":{"example":"specific-agents","pattern":"^specific-agents$","type":"string"},"maxMachines":{"default":25,"description":"Maximum number of agents which can execute the test.","example":25,"type":"integer"},"agents":{"description":"List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType` is set to `specific-agent`.","example":["0a3b9998-dc3a-4ff2-b50d-ac4a7cd986e1","66eec0f1-72b4-4755-aa83-3aed61d17f3c"],"items":{"format":"uuid","type":"string"},"type":"array"}},"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointSpecificAgentsSelectorConfig"}],"readOnly":true,"required":["agentSelectorType"],"type":"object","$$ref":"#/components/schemas/EndpointAgentSelectorConfig"},"application":{"description":"Which supported application to monitor, can be one of `webex`, `zoom`, `microsoft-teams`.","example":"webex","type":"string"},"createdDate":{"description":"UTC created date (ISO date-time format).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"interval":{"default":60,"description":"Interval between test runs in seconds.","enum":[60,120,300,600,900,1800,3600],"example":60,"type":"integer","$$ref":"#/components/schemas/TestInterval"},"isEnabled":{"default":true,"description":"Indicates if test is enabled.","example":true,"type":"boolean"},"hasPathTraceInSession":{"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,"type":"boolean"},"hasPing":{"default":true,"description":"Optional flag indicating if the test should run ping.","type":"boolean"},"hasTraceroute":{"default":true,"description":"Optional flag indicating if the test should run traceroute.","type":"boolean"},"modifiedDate":{"description":"UTC last modification date (ISO date-time format).","example":"2022-07-17T22:00:54Z","format":"date-time","readOnly":true,"type":"string"},"networkMeasurements":{"default":true,"description":"Enable or disable network measurements. Set to true to enable or false to disable network measurements.","example":true,"type":"boolean"},"protocol":{"default":"icmp","description":"Protocol requested for the test.","enum":["icmp","icmp-with-tcp-connect","tcp","prefer-tcp","ast-autodetect","autodetect"],"example":"icmp","type":"string","$$ref":"#/components/schemas/EndpointTestProtocol"},"ipVersion":{"description":"IP version the test should use for network tests.","enum":["V4_ONLY","V6_ONLY","V6_PREFER","OS_DEFAULT"],"example":"V4_ONLY","type":"string","$$ref":"#/components/schemas/EndpointIpVersionTemplate"},"tcpProbeMode":{"default":"auto","description":"Probe mode used by network test, only valid when the protocol is set to TCP.","enum":["auto","sack","syn","unknown"],"example":"auto","type":"string","$$ref":"#/components/schemas/TestProbeModeResponse"},"testId":{"description":"Each test is assigned a unique ID; this is used to access test information and results from other endpoints.","example":"281474976710706","readOnly":true,"type":"string"},"testName":{"description":"Name of the test.","example":"Test name","type":"string"},"labels":{"items":{"example":{"labelId":"961","name":"Artem label","isBuiltin":false},"properties":{"labelId":{"description":"Label ID.","type":"string"},"name":{"description":"Name of the label.","type":"string"},"isBuiltin":{"description":"Value indicating if the label in question is BuiltIn (Account Admin, Organization Admin, Regular User).","type":"boolean"}},"type":"object","$$ref":"#/components/schemas/TestLabel"},"readOnly":true,"type":"array"}},"type":"object","$$ref":"#/components/schemas/DynamicTest"},"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/NetworkDynamicEndpointTestResults"}}},"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 dynamic test results","tags":["Network Dynamic Endpoint Test Results"],"__originalOperationId":"filterDynamicTestNetworkResults","security":[{"BearerAuth":[]}],"method":"post","path":"/endpoint/test-results/dynamic-tests/{testId}/network/filter"}}