{"type":"model","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":{"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"},"asnDetails":{"properties":{"asName":{"description":"Name of the provider.","example":"ThousandEyes, Inc","readOnly":true,"type":"string"},"asNumber":{"description":"Unique number assigned to an organization (also referred to as service provider).","example":394101,"readOnly":true,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/AsnDetails"},"server":{"description":"Target server, including port.","example":"www.google.com:443","readOnly":true,"type":"string"},"sourceIp":{"description":"IP address of source endpoint agent.","example":"196.40.106.237","readOnly":true,"type":"string"},"sourcePrefix":{"description":"IP prefix of source endpoint agent.","example":"196.40.96.0/20","readOnly":true,"type":"string"},"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"},"location":{"description":"Geographic location of the path visualization.","example":"San Francisco Area","readOnly":true,"type":"string"},"pathTraces":{"description":"Shows an iteration of path trace, with each iteration specified by a pathId.","items":{"properties":{"ipAddress":{"description":"IP address of the hop destination.","example":"196.40.106.237","readOnly":true,"type":"string"},"numberOfHops":{"description":"Number of hops for path trace to destination.","example":15,"readOnly":true,"type":"integer"},"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"},"tcpPathTraceMode":{"default":"auto","description":"Path trace mode used by network test. Only valid when the protocol is set to TCP.","enum":["auto","syn","unknown","data-in-session-with-decrementing-ttl","data-in-session"],"example":"auto","type":"string","$$ref":"#/components/schemas/TcpPathTraceModeResponse"},"udpPathTraceMode":{"default":"unknown","description":"Path trace 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/UdpPathTraceModeResponse"},"pathId":{"description":"Unique ID of path trace.","example":"1230899668701775614109128428722974545787322404682781961521","readOnly":true,"type":"string"},"responseTime":{"description":"RTT of the path trace to the destination in milliseconds.","example":1500,"readOnly":true,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/EndpointPathTrace"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/PathVisDynamicEndpointTestResult","title":"PathVisDynamicEndpointTestResult"}}