Consent Manager

  • Your Privacy

  • Strictly Necessary Cookies

  • Performance Cookies

  • Targeting Cookies

  • Functional Cookies

Your Privacy

When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer. For more information on the information we collect and how we use it see the Website Privacy Statement.

Strictly Necessary Cookies

Always Active

These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.

Performance Cookies

Off On

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.

Targeting Cookies

Off On

These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising.

Functional Cookies

These cookies enable the website to provide enhanced functionality and personalization. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

Your Privacy [`dialog closed`]

By continuing to use our website, you acknowledge the use of cookies. Privacy Statement | Change Settings

Cookies allow us to optimise your use of our website. We also use third-party cookies for advertising and analytics. Please read our Privacy Statement and Website Privacy Statement for more information on how we use cookies.

DEVELOPER REFERENCE

Search Results

×Clear
  • Overview

    • Welcome
    • Authentication
    • Account group context
    • Response formats
    • Time ranges
    • Response status codes
    • Rate limits
    • Pagination
    • Change policy
    • API change summary
  • Instant tests

    • Instant test
    • Instant test rerun
  • Tests

    • Test list
    • Test list by type
    • Test details
    • Test metadata
    • Creating a test
    • Updating a test
    • Deleting a test
    • Saved events
    • Path vis interface group list
    • Creating path vis interface group
    • Updating path vis interface group
    • Deleting path vis interface group
  • Test Data

    • (Network) End-to-End metrics
    • (Network) Path visualization
    • (Network) Detailed path trace
    • (Network) BGP metrics
    • (Network) BGP route information
    • (Web) HTTP server
    • (Web) Page load
    • (Web) Page load component detail
    • (Web) Web Transactions
    • (Web) Web Transaction detail
    • (Web) Web Transaction component detail
    • (Web) FTP server
    • (DNS) Domain trace
    • (DNS) Server metrics
    • (DNS) DNSSEC
    • (Voice) SIP server
    • (Voice) RTP stream
  • Credentials

    • Credential list
    • Credential details
    • Creating a credential
    • Updating a credential
    • Deleting a credential
  • Endpoint Agents

    • Listing all agents
    • Getting an agent by id
    • Updating an agent
    • Enabling an agent
    • Disabling an agent
    • Transferring an agent
    • Deleting an agent
  • Endpoint Data

    • Endpoint user session list
    • Endpoint user session details
    • Endpoint web pages list
    • Endpoint web page details
    • Endpoint network sessions list
    • Endpoint network topology list
    • Endpoint network topology details
    • Endpoint data filtering
    • Endpoint networks
  • Endpoint Tests

    • Scheduled Test List
    • Scheduled Test List by Type
    • Scheduled Test Details
    • Scheduled Test Metadata
    • Creating a Scheduled Test
    • Automated Session Test List
    • Automated Session Test Details
    • Automated Session Test Metadata
    • Creating an Automated Session Test
  • Endpoint Instant Tests

    • Creating instant test
    • Rerunning instant test
  • Endpoint Test Data

    • Scheduled Tests (Network) End-to-End metrics
    • Scheduled Tests (Network) Path visualization
    • Scheduled Tests (Network) Detailed path trace
    • Scheduled Tests (Web) HTTP server
    • Automated Session Tests End-to-End metrics
    • Automated Session Tests Path visualization
    • Automated Session Tests Detailed path trace
  • Snapshots

    • Create a new snapshot
  • Agents & Monitors

    • Agent list
    • Agent detail
    • Updating an agent
    • Deleting an Agent
    • Agent cluster - Creating
    • Agent cluster - Adding members
    • Agent cluster - Removing members
    • Agent cluster - Converting to an agent
    • BGP Monitor list
    • Agent Notification Rules
    • Agent Notification Rule Detail
  • Alerts & Notifications

    • Active alerts
    • Alert detail
    • Alert rules
    • Alert rule detail
    • Alert rule metadata
    • Creating an alert rule
    • Updating an alert rule
    • Deleting an alert rule
    • Alert notification integrations
    • Alert suppression windows
    • Alert suppression window detail
    • Creating an alert suppression window
    • Updating an alert suppression window
    • Deleting an alert suppression window
    • Creating an advanced Alert Rule
  • Labels

    • Labels list
    • Labels list by type
    • Label details
    • Label details (by label type)
    • Creating a label
    • Updating a label
    • Deleting a label
  • Reports

    • Reports list
    • Report detail
    • Report data
    • Deleting a report
    • Report snapshots list
    • Report snapshot detail
    • Report snapshot data
    • Deleting a report snapshot
  • Dashboards

    • Dashboards list
    • Dashboards detail
    • Dashboard data
    • Deleting a dashboard
    • Dashboard snapshots list
    • Dashboards snapshot detail
    • Dashboard snapshot data
    • Deleting a dashboard snapshot
  • Administrative endpoints

    • Account group list
    • Account group detail
    • Creating an account group
    • Updating an account group
    • Deleting an account group
    • User list
    • User detail
    • Adding a user
    • Updating a user
    • Deleting a user
    • Role list
    • Role detail
    • Creating a role
    • Updating a role
    • Permission list
    • Activity log
    • Obtaining usage quota
    • Updating usage quotas
  • Usage

    • Obtaining usage details
    • Usage metadata

  • Showing APIv6  |  APIv7 (preview)

  • Product Documentation
  • Customer Success Center
  • Public GitHub Repository

Try ThousandEyes Now! Sign Up

Endpoint Test Data

GET /v6/endpoint-data/tests/net/metrics/{testId} Scheduled Tests (Network) End-to-End metrics

Returns network metrics (loss, latency, jitter and bandwidth) from each endpoint agent, for each roundId in the requested window. A time frame must be specified, or the most recent round within last 2 hours will be returned.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • window=[0-9]+[smhdw]? specifies a window of time for the result set. See Time Ranges for more information.
  • from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SS specifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

  • {testId} the ID of the endpoint scheduled test you wish to retrieve
  • There is no request body for this request.

Response

FieldData TypeUnitsNotes
agentIdstringn/aUnique ID of endpoint agent, from /endpoint-agents endpoint
avgLatencyfloatmillisecondsAverage RTT for packets sent to destination
errorDetailsstringn/aError details, if an error was encountered
jitterfloatmillisecondsStandard deviation of latency
lossfloatpercentage% of packets not reaching destination
maxLatencyintegermillisecondsMaxmimum RTT for packets sent to destination
minLatencyintegermillisecondsMinimum RTT for packets sent to destination
permalinkurln/aLink to jump to this result in the front end
roundIdlongsecondsEpoch time (seconds) indicating the start time of the round
serverIpstringn/aIP address of target server
systemMetricsobjectn/aContains system metrics such as CPU and physical memory usage

systemMetrics object has the following properties:

FieldData TypeUnitsNotes
startTimeMsintegermillisecondsTime at which metrics collection started, as milliseconds since the Epoch
endTimeMsintegermillisecondsTime at which metrics collection ended, as milliseconds since the Epoch
cpuUtilizationobjectn/aContains utilization of the system’s processors over the monitored period
physicalMemoryUsedBytesobjectn/aContains metrics about used physical memory
physicalMemoryTotalBytesintegerbytesTotal physical memory of the system

cpuUtilization object has the following properties:

FieldData TypeUnitsNotes
mindouble[0.0-1.0]Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
maxdouble[0.0-1.0]Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
meandouble[0.0-1.0]Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mediandouble[0.0-1.0]Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDevdouble[0.0-1.0]Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
countintegern/aThe number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

FieldData TypeUnitsNotes
mindoublebytesMinimal value of memory usage sampled over the monitored period
maxdoublebytesMaximal value of memory usage sampled over the monitored period
meandoublebytesMean value of memory usage sampled over the monitored period
mediandoublebytesMedian value of memory usage sampled over the monitored period
stdDevdoublebytesStandard deviation of memory usage sampled over the monitored period
countintegern/aThe number of collected samples over the monitored period

Example

$ curl https://api.thousandeyes.com/v6/endpoint-data/tests/net/metrics/273.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 21:19:54 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 239 X-Organization-Rate-Limit-Reset: 1535232000 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-2

Body

{ "endpointNet": { "endpointTest": {...}, "metrics": [ { "agentId": "1cf6d996-2400-4724-a805-2de78756c209", "avgLatency": 10.0, "jitter": 1.0, "loss": 0.0, "maxLatency": 13.0, "minLatency": 7.0, "permalink": "https://app.thousandeyes.com/view/endpoint-agent?__a=160&scenarioId=eyebrowNetworkTest&testId=273&roundId=1535228220", "roundId": 1535228220, "serverIp": "185.199.108.153", "systemMetrics": { "startTimeMs": 1581508857327, "endTimeMs": 1581508867333, "cpuUtilization": { "min": 0.30859375, "max": 0.5625, "mean": 0.38931831001805056, "median": 0.353515625, "stdDev": 0.08389194281742307, "count": 10 }, "physicalMemoryUsedBytes": { "min": 1.2805128192E10, "max": 1.2825530368E10, "mean": 1.281914582109091E10, "median": 1.2818219008E10, "stdDev": 5741124.05691331, "count": 11 }, "physicalMemoryTotalBytes": 17069891584 } }, ... ] }, "pages": { "current": 1 } }

For more information on our HTTP response status codes, see the response status codes documentation.

GET /v6/endpoint-data/tests/net/path-vis/{testId} Scheduled Tests (Network) Path visualization

Returns a summary of the path visualization data collected from each endpoint agent to the destination. In each path visualization attempt, one attempt is made to reach the destination. Each set of data is summarized, based on response time, number of hops, and response time to the target. A time frame must be specified, or the most recent round within last 2 hours will be returned.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • window=[0-9]+[smhdw]? specifies a window of time for the result set. See Time Ranges for more information.
  • from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SS specifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

  • {testId} the ID of the test you wish to retrieve
  • There is no request body for this request.

Response

FieldData TypeUnitsNotes
agentIdstringn/aUnique ID of agent, from /endpoint-agents endpoint
asnDetailsobjectn/aContains ASN information
locationstringn/aGeographic location of the endpoint agent
permalinkurln/aLink to jump to this result in the front end
roundIdlongsecondsEpoch time (seconds) indicating the start time of the round
serverurln/aTarget server, including port
serverIpstringn/aIP address of target server
sourceIpstringn/aIP address of source endpoint agent
sourcePrefixstringn/aIP prefix of source agent
endpointsarrayn/aShows all iterations of path trace, with each iteration specified by a pathId
endpoints.ipAddressstringn/aDestination
endpoints.numberOfHopsintegern/aNumber of hops for path trace to destination
endpoints.pathIdstringn/aUnique ID of path trace
endpoints.responseTimeintegern/aRTT of the path trace to the destination
systemMetricsobjectn/aContains system metrics such as CPU and physical memory usage
vpnProfileobjectn/aContains information about the currently active VPN

systemMetrics object has the following properties:

FieldData TypeUnitsNotes
startTimeMsintegermillisecondsTime at which metrics collection started, as milliseconds since the Epoch
endTimeMsintegermillisecondsTime at which metrics collection ended, as milliseconds since the Epoch
cpuUtilizationobjectn/aContains utilization of the system’s processors over the monitored period
physicalMemoryUsedBytesobjectn/aContains metrics about used physical memory
physicalMemoryTotalBytesintegerbytesTotal physical memory of the system

cpuUtilization object has the following properties:

FieldData TypeUnitsNotes
mindouble[0.0-1.0]Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
maxdouble[0.0-1.0]Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
meandouble[0.0-1.0]Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mediandouble[0.0-1.0]Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDevdouble[0.0-1.0]Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
countintegern/aThe number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

FieldData TypeUnitsNotes
mindoublebytesMinimal value of memory usage sampled over the monitored period
maxdoublebytesMaximal value of memory usage sampled over the monitored period
meandoublebytesMean value of memory usage sampled over the monitored period
mediandoublebytesMedian value of memory usage sampled over the monitored period
stdDevdoublebytesStandard deviation of memory usage sampled over the monitored period
countintegern/aThe number of collected samples over the monitored period

vpnProfile object has the following properties:

FieldData TypeNotes
vpnClientAddressesarrayList of private IP addresses that the VPN server assigned to the device
vpnClientNetworkRangearrayList of private networks that the VPN server assigned to the device
vpnGatewayAddressstringIP address of the VPN gateway
vpnTypestringName of the VPN provider. For example, “CiscoAnyConnect” or “ZscalerInternet”

asnDetails object has the following properties:

FieldData TypeNotes
asNamestringname of the provider. For example, “ThousandEyes, Inc.”
asNumberlongunique number assigned to an organization(also referred to as service provider)

Example

$ curl https://api.thousandeyes.com/v6/endpoint-data/tests/net/path-vis/273.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Wed, 29 Aug 2018 14:01:39 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 239 X-Organization-Rate-Limit-Reset: 1535551320 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointNet": { "endpointTest": {...}, "pathVis": [ { "agentId": "1cf6d996-2400-4724-a805-2de78756c209", "endpoints": [ { "ipAddress": "185.199.111.153", "numberOfHops": 8, "pathId": "8498006760529413427021933451903980591243082534558334817588690338427397277769705862118603451313420092120640807102236650497915440", "responseTime": 5 } ], "location": "San Francisco Area", "permalink": "https://app.thousandeyes.com/view/endpoint-agent?__a=160&scenarioId=eyebrowNetworkTest&testId=273&roundId=1535550480", "roundId": 1535550480, "server": "developer.thousandeyes.com:443", "serverIp": "185.199.111.153", "sourceIp": "10.100.10.35", "sourcePrefix": "38.122.6.64/30", "systemMetrics": { "startTimeMs": 1581508857327, "endTimeMs": 1581508867333, "cpuUtilization": { "min": 0.30859375, "max": 0.5625, "mean": 0.38931831001805056, "median": 0.353515625, "stdDev": 0.08389194281742307, "count": 10 }, "physicalMemoryUsedBytes": { "min": 1.2805128192E10, "max": 1.2825530368E10, "mean": 1.281914582109091E10, "median": 1.2818219008E10, "stdDev": 5741124.05691331, "count": 11 }, "physicalMemoryTotalBytes": 17069891584 }, "vpnProfile": { "vpnType": "CiscoAnyConnect", "vpnGatewayAddress": "144.254.221.38" }, "asnDetails": { "asNumber": 394101, "asName": "ThousandEyes, Inc." } }, ... ] }, "pages": { "current": 1 } }

For more information on our HTTP response status codes, see the response status codes documentation.

GET /v6/endpoint-data/tests/net/path-vis/{testId}/{agentId}/{roundId} Scheduled Tests (Network) Detailed path trace

Returns a hop-by-hop summary of the path trace data collected during path visualization. In each round, one path discovery attempt is made to reach the destination. The entire path is returned. A roundId must be specified.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

Required parameters:

  • {testId} the ID of the test you wish to retrieve
  • {agentId} the ID of the endpoint agent from which you wish to obtain data
  • {roundId} the round ID for which you wish to obtain data. Equals the beginning of the testing round, in epoch time format.
  • There is no request body for this request.

Response

  • Each route should start with a hop of 1
  • Where a hop number is missing from response data, this is an indication that a star (*) response was returned in the path trace attempt for that hop.
FieldData TypeUnitsNotes
agentIdstringn/aUnique ID of agent, from /endpoint-agents endpoint
asnDetailsobjectn/aContains ASN information
permalinkurln/aLink to jump to this result in the front end
roundIdlongsecondsEpoch time (seconds) indicating the start time of the round
serverurln/aTarget server, including port
serverIpstringn/aIP address of target server
sourceIpstringn/aIP address of source endpoint agent
sourcePrefixstringn/aIP prefix of source agent
routesarrayn/aShows an iteration of path trace, with each iteration specified by a pathId
routes.pathIdstringn/aUnique ID of path trace
routes.hopsarrayn/aArray of hop objects indicating each step in the traceroute
routes.hops.hopintegern/aIndex of hop
routes.hops.ipAddressstringn/aIP address of the hop
routes.hop.prefixstringn/aPrefix of IP address shown in CIDR
routes.hop.rdnsstringn/aReverse DNS entry of IP, if available
routes.hop.networkstringn/aAutonomous System originating the prefix
routes.hop.responseTimeintegermillisecondsRTT to the hop’s IP
routes.hop.locationstringn/aLocation information for the hop
systemMetricsobjectn/aContains system metrics such as CPU and physical memory usage
vpnProfileobjectn/aContains information about the currently active VPN

systemMetrics object has the following properties:

FieldData TypeUnitsNotes
startTimeMsintegermillisecondsTime at which metrics collection started, as milliseconds since the Epoch
endTimeMsintegermillisecondsTime at which metrics collection ended, as milliseconds since the Epoch
cpuUtilizationobjectn/aContains utilization of the system’s processors over the monitored period
physicalMemoryUsedBytesobjectn/aContains metrics about used physical memory
physicalMemoryTotalBytesintegerbytesTotal physical memory of the system

cpuUtilization object has the following properties:

FieldData TypeUnitsNotes
mindouble[0.0-1.0]Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
maxdouble[0.0-1.0]Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
meandouble[0.0-1.0]Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mediandouble[0.0-1.0]Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDevdouble[0.0-1.0]Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
countintegern/aThe number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

FieldData TypeUnitsNotes
mindoublebytesMinimal value of memory usage sampled over the monitored period
maxdoublebytesMaximal value of memory usage sampled over the monitored period
meandoublebytesMean value of memory usage sampled over the monitored period
mediandoublebytesMedian value of memory usage sampled over the monitored period
stdDevdoublebytesStandard deviation of memory usage sampled over the monitored period
countintegern/aThe number of collected samples over the monitored period

vpnProfile object has the following properties:

FieldData TypeNotes
vpnClientAddressesarrayList of private IP addresses that the VPN server assigned to the device
vpnClientNetworkRangearrayList of private networks that the VPN server assigned to the device
vpnGatewayAddressstringIP address of the VPN gateway
vpnTypestringName of the VPN provider. For example, “CiscoAnyConnect” or “ZscalerInternet”

asnDetails object has the following properties:

FieldData TypeNotes
asNamestringname of the provider. For example, “ThousandEyes, Inc.”
asNumberlongunique number assigned to an organization(also referred to as service provider)

Example

$ curl https://api.thousandeyes.com/v6/endpoint-data/tests/net/path-vis/273/1cf6d996-2400-4724-a805-2de78756c209/1535551380.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Wed, 29 Aug 2018 14:08:20 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 239 X-Organization-Rate-Limit-Reset: 1535551740 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-5

Body

{ "endpointNet": { "endpointTest": {...}, "pathVis": [ { "agentId": "1cf6d996-2400-4724-a805-2de78756c209", "permalink": "https://app.thousandeyes.com/view/endpoint-agent?__a=160&scenarioId=eyebrowNetworkTest&testId=273&roundId=1535551380", "roundId": 1535551380, "routes": [ { "hops": [ { "hop": 1, "ipAddress": "10.100.10.1", "rdns": "vlan10.fw1.sfo1.o.thousandeyes.com", "responseTime": 3 }, { "hop": 2, "ipAddress": "38.122.6.65", "location": "San Francisco, California, US", "network": "Cogent Communications (AS 174)", "prefix": "38.0.0.0/8", "rdns": "gi0-0-0-4.nr11.b001920-0.sfo01.atlas.cogentco.com", "responseTime": 4 }, { "hop": 3, "ipAddress": "154.24.7.73", "location": "San Francisco, California, US", "network": "Cogent Communications (AS 174)", "prefix": "154.24.0.0/13", "rdns": "gi0-0-0-6.agr22.sfo01.atlas.cogentco.com", "responseTime": 3 }, { "hop": 4, "ipAddress": "154.54.30.221", "location": "San Francisco, California, US", "network": "Cogent Communications (AS 174)", "prefix": "154.48.0.0/12", "rdns": "be2905.ccr22.sfo01.atlas.cogentco.com", "responseTime": 4 }, { "hop": 5, "ipAddress": "154.54.0.178", "location": "San Jose, California, US", "network": "Cogent Communications (AS 174)", "prefix": "154.48.0.0/12", "rdns": "be2016.ccr31.sjc04.atlas.cogentco.com", "responseTime": 4 }, { "hop": 6, "ipAddress": "62.115.34.73", "location": "San Jose, California, US", "network": "TeliaNet Global Network (AS 1299)", "prefix": "62.115.0.0/16", "rdns": "palo-b1-link.telia.net", "responseTime": 6 }, { "hop": 8, "ipAddress": "185.199.111.153", "location": "San Jose, California, US", "network": "Fastly (AS 54113)", "prefix": "185.199.111.0/24", "rdns": "185.199.111.153", "responseTime": 4 } ], "pathId": "8498006760529413427021933451903980591243082534558334817588690338427397277769705862118603451313420092120640807102237745714575920" } ], "server": "developer.thousandeyes.com:443", "serverIp": "185.199.111.153", "sourceIp": "10.100.10.35", "sourcePrefix": "38.122.6.64/30", "systemMetrics": { "startTimeMs": 1581508857327, "endTimeMs": 1581508867333, "cpuUtilization": { "min": 0.30859375, "max": 0.5625, "mean": 0.38931831001805056, "median": 0.353515625, "stdDev": 0.08389194281742307, "count": 10 }, "physicalMemoryUsedBytes": { "min": 1.2805128192E10, "max": 1.2825530368E10, "mean": 1.281914582109091E10, "median": 1.2818219008E10, "stdDev": 5741124.05691331, "count": 11 }, "physicalMemoryTotalBytes": 17069891584 }, "vpnProfile": { "vpnType": "CiscoAnyConnect", "vpnGatewayAddress": "144.254.221.38" }, "asnDetails": { "asNumber": 394101, "asName": "ThousandEyes, Inc." } } ] } }

For more information on our HTTP response status codes, see the response status codes documentation.

GET /v6/endpoint-data/tests/web/http-server/{testId} Scheduled Tests (Web) HTTP server

Returns response code and response times, as well as component-level (DNS, Connect, Wait and Receive) timing for the load of an object over HTTP.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • window=[0-9]+[smhdw]? specifies a window of time for the result set. See Time Ranges for more information.
  • from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SS specifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

  • {testId} the ID of the HTTP Server (or page load) test you wish to retrieve
  • There is no request body for this request.

Response

FieldData TypeUnitsNotes
agentIdstringn/aUnique ID of agent, from /endpoint-agents endpoint
connectTimeintegermillisecondsTime required to establish a TCP connection to the server
dnsTimeintegermillisecondsTime required to resolve DNS
errorTypestringn/aType of error encountered; corresponds to phase of connection
errorDetailsstringn/aError details, if an error was encountered
numRedirectsintegern/aNumber of redirects
permalinkurln/aLink to jump to this result in the front end
receiveTimeintegermillisecondsElapsed time between first and last byte of response
redirectTimeintegermillisecondsCumulative redirect timing
requestHeadersstringn/aCRLF-delimited list of request headers in header: value format
responseCodeintegern/aCode of HTTP response
responseHeadersstringn/aCRLF-delimited list of response headers in header: value format
responseTimeintegermillisecondsTime to first byte
roundIdlongsecondsEpoch time (seconds) indicating the start time of the round
serverIpstringn/aIP address of destination server
sslTimeintegermillisecondsTime to negotiate SSL/TLS
totalTimeintegermillisecondsResponse time + receive time
waitTimeintegermillisecondsTime elapsed between completion of request and first byte of response
wireSizefloatbytesSize of content, in bytes
systemMetricsobjectn/aContains system metrics such as CPU and physical memory usage

systemMetrics object has the following properties:

FieldData TypeUnitsNotes
startTimeMsintegermillisecondsTime at which metrics collection started, as milliseconds since the Epoch
endTimeMsintegermillisecondsTime at which metrics collection ended, as milliseconds since the Epoch
cpuUtilizationobjectn/aContains utilization of the system’s processors over the monitored period
physicalMemoryUsedBytesobjectn/aContains metrics about used physical memory
physicalMemoryTotalBytesintegerbytesTotal physical memory of the system

cpuUtilization object has the following properties:

FieldData TypeUnitsNotes
mindouble[0.0-1.0]Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
maxdouble[0.0-1.0]Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
meandouble[0.0-1.0]Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mediandouble[0.0-1.0]Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDevdouble[0.0-1.0]Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
countintegern/aThe number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

FieldData TypeUnitsNotes
mindoublebytesMinimal value of memory usage sampled over the monitored period
maxdoublebytesMaximal value of memory usage sampled over the monitored period
meandoublebytesMean value of memory usage sampled over the monitored period
mediandoublebytesMedian value of memory usage sampled over the monitored period
stdDevdoublebytesStandard deviation of memory usage sampled over the monitored period
countintegern/aThe number of collected samples over the monitored period

Example

$ curl https://api.thousandeyes.com/v6/endpoint-data/tests/web/http-server/273.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Wed, 29 Aug 2018 14:28:18 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 237 X-Organization-Rate-Limit-Reset: 1535552940 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-4

Body

{ "endpointWeb": "endpointTest": {...}, "httpServer": [ { "agentId": "1cf6d996-2400-4724-a805-2de78756c209", "connectTime": 12, "dnsTime": 6, "errorType": "None", "permalink": "https://app.thousandeyes.com/view/endpoint-agent?__a=160&scenarioId=eyebrowHttp&testId=273&roundId=1535551800", "receiveTime": 17, "requestHeaders": "GET / HTTP/1.1\r\n\nHost: developer.thousandeyes.com\r\n\nAuthorization: Basic (removed)\r\n\nUser-Agent: curl/\r\n\nAccept: */*\r\n\nX-ThousandEyes-Endpoint-Agent: yes\r\n", "responseCode": 200, "responseHeaders": "HTTP/1.1 200 OK\r\n\nServer: GitHub.com\r\n\nContent-Type: text/html; charset=utf-8\r\n\nLast-Modified: Thu, 23 Aug 2018 14:16:48 GMT\r\n\nETag: \"5b7ec1d0-14f4f\"\r\n\nAccess-Control-Allow-Origin: *\r\n\nExpires: Thu, 23 Aug 2018 14:37:00 GMT\r\n\nCache-Control: max-age=600\r\n\nX-GitHub-Request-Id: F86C:9AD2:7ABF9:89530:5B7EC42E\r\n\nContent-Length: 85839\r\n\nAccept-Ranges: bytes\r\n\nDate: Wed, 29 Aug 2018 14:10:00 GMT\r\n\nVia: 1.1 varnish\r\n\nAge: 480\r\n\nConnection: keep-alive\r\n\nX-Served-By: cache-pao17433-PAO\r\n\nX-Cache: HIT\r\n\nX-Cache-Hits: 1\r\n\nX-Timer: S1535551800.182689,VS0,VE1\r\n\nVary: Accept-Encoding\r\n\nX-Fastly-Request-ID: a665076014deec318792ec930c9cd6ae62fd2ae3\r\n", "responseTime": 46, "roundId": 1535551800, "serverIp": "185.199.111.153", "sslTime": 11, "totalTime": 63, "waitTime": 16, "wireSize": 86462, "systemMetrics": { "startTimeMs": 1581508857327, "endTimeMs": 1581508867333, "cpuUtilization": { "min": 0.30859375, "max": 0.5625, "mean": 0.38931831001805056, "median": 0.353515625, "stdDev": 0.08389194281742307, "count": 10 }, "physicalMemoryUsedBytes": { "min": 1.2805128192E10, "max": 1.2825530368E10, "mean": 1.281914582109091E10, "median": 1.2818219008E10, "stdDev": 5741124.05691331, "count": 11 }, "physicalMemoryTotalBytes": 17069891584 } }, ... ] }, "pages": { "current": 1 } }

For more information on our HTTP response status codes, see the response status codes documentation.

GET /v6/endpoint-data/automated-session-tests/net/metrics/{testId} Automated Session Tests End-to-End metrics

Returns network metrics (loss, latency, jitter and bandwidth) from each endpoint agent, for each roundId in the requested window. A time frame must be specified, or the most recent round within last 2 hours will be returned.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • window=[0-9]+[smhdw]? specifies a window of time for the result set. See Time Ranges for more information.
  • from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SS specifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

  • {testId} the ID of the endpoint automated session test you wish to retrieve
  • There is no request body for this request.

Response

FieldData TypeUnitsNotes
agentIdstringn/aUnique ID of endpoint agent, from /endpoint-agents endpoint
avgLatencyfloatmillisecondsAverage RTT for packets sent to destination
errorDetailsstringn/aError details, if an error was encountered
jitterfloatmillisecondsStandard deviation of latency
lossfloatpercentage% of packets not reaching destination
maxLatencyintegermillisecondsMaxmimum RTT for packets sent to destination
minLatencyintegermillisecondsMinimum RTT for packets sent to destination
permalinkurln/aLink to jump to this result in the front end
roundIdlongsecondsEpoch time (seconds) indicating the start time of the round
serverIpstringn/aIP address of target server
systemMetricsobjectn/aContains system metrics such as CPU and physical memory usage
applicationstringn/aMonitored application, can be one of WEBEX, ZOOM, MSTEAMS
webexobjectn/aContains metadata of a Webex test e.g. Webex conference id

systemMetrics object has the following properties:

FieldData TypeUnitsNotes
startTimeMsintegermillisecondsTime at which metrics collection started, as milliseconds since the Epoch
endTimeMsintegermillisecondsTime at which metrics collection ended, as milliseconds since the Epoch
cpuUtilizationobjectn/aContains utilization of the system’s processors over the monitored period
physicalMemoryUsedBytesobjectn/aContains metrics about used physical memory
physicalMemoryTotalBytesintegerbytesTotal physical memory of the system

cpuUtilization object has the following properties:

FieldData TypeUnitsNotes
mindouble[0.0-1.0]Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
maxdouble[0.0-1.0]Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
meandouble[0.0-1.0]Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mediandouble[0.0-1.0]Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDevdouble[0.0-1.0]Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
countintegern/aThe number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

FieldData TypeUnitsNotes
mindoublebytesMinimal value of memory usage sampled over the monitored period
maxdoublebytesMaximal value of memory usage sampled over the monitored period
meandoublebytesMean value of memory usage sampled over the monitored period
mediandoublebytesMedian value of memory usage sampled over the monitored period
stdDevdoublebytesStandard deviation of memory usage sampled over the monitored period
countintegern/aThe number of collected samples over the monitored period

Example

$ curl https://api.thousandeyes.com/v6/endpoint-data/automated-session-tests/net/metrics/273.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK HTTP/1.1 200 OK Server: nginx Date: Sat, 25 Aug 2018 21:19:54 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 239 X-Organization-Rate-Limit-Reset: 1535232000 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-2

Body

{ "endpointAutomatedSessionTestNet": { "automatedSessionTest": {...}, "metrics": [ { "agentId": "1cf6d996-2400-4724-a805-2de78756c209", "avgLatency": 10.0, "jitter": 1.0, "loss": 0.0, "maxLatency": 13.0, "minLatency": 7.0, "permalink": "https://app.thousandeyes.com/view/endpoint-agent?__a=160&scenarioId=eyebrowNetworkTest&testId=273&roundId=1535228220", "roundId": 1535228220, "serverIp": "185.199.108.153", "webex": { "conferenceId": "225817074608419375" "correlationId": "22581707460321454" }, "application": "WEBEX", "systemMetrics": { "startTimeMs": 1581508857327, "endTimeMs": 1581508867333, "cpuUtilization": { "min": 0.30859375, "max": 0.5625, "mean": 0.38931831001805056, "median": 0.353515625, "stdDev": 0.08389194281742307, "count": 10 }, "physicalMemoryUsedBytes": { "min": 1.2805128192E10, "max": 1.2825530368E10, "mean": 1.281914582109091E10, "median": 1.2818219008E10, "stdDev": 5741124.05691331, "count": 11 }, "physicalMemoryTotalBytes": 17069891584 } }, ... ] }, "pages": { "current": 1 } }

For more information on our HTTP response status codes, see the response status codes documentation.

GET /v6/endpoint-data/automated-session-tests/net/path-vis/{testId} Automated Session Tests Path visualization

Returns a summary of the path visualization data collected from each endpoint agent to the destination. In each path visualization attempt, one attempt is made to reach the destination. Each set of data is summarized, based on response time, number of hops, and response time to the target. A time frame must be specified, or the most recent round within last 2 hours will be returned.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • window=[0-9]+[smhdw]? specifies a window of time for the result set. See Time Ranges for more information.
  • from=YYYY-mm-ddTHH:MM:SS&to=YYYY-mm-ddTHH:MM:SS specifies an explicit start (and optionally, end) for your range of data. See Time Ranges for more information.
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

  • {testId} the ID of the test you wish to retrieve
  • There is no request body for this request.

Response

FieldData TypeUnitsNotes
agentIdstringn/aUnique ID of agent, from /endpoint-agents endpoint
asnDetailsobjectn/aContains ASN information
locationstringn/aGeographic location of the endpoint agent
permalinkurln/aLink to jump to this result in the front end
roundIdlongsecondsEpoch time (seconds) indicating the start time of the round
serverurln/aTarget server, including port
serverIpstringn/aIP address of target server
sourceIpstringn/aIP address of source endpoint agent
sourcePrefixstringn/aIP prefix of source agent
endpointsarrayn/aShows all iterations of path trace, with each iteration specified by a pathId
endpoints.ipAddressstringn/aDestination
endpoints.numberOfHopsintegern/aNumber of hops for path trace to destination
endpoints.pathIdstringn/aUnique ID of path trace
endpoints.responseTimeintegern/aRTT of the path trace to the destination
systemMetricsobjectn/aContains system metrics such as CPU and physical memory usage
applicationstringn/aMonitored application, can be one of WEBEX, ZOOM, MSTEAMS
webexobjectn/aContains metadata of a Webex test e.g. Webex conference id
vpnProfileobjectn/aContains information about the currently active VPN

systemMetrics object has following properties:

FieldData TypeUnitsNotes
startTimeMsintegermillisecondsTime at which metrics collection started, as milliseconds since the Epoch
endTimeMsintegermillisecondsTime at which metrics collection ended, as milliseconds since the Epoch
cpuUtilizationobjectn/aContains utilization of the system’s processors over the monitored period
physicalMemoryUsedBytesobjectn/aContains metrics about used physical memory
physicalMemoryTotalBytesintegerbytesTotal physical memory of the system

cpuUtilization object has the following properties:

FieldData TypeUnitsNotes
mindouble[0.0-1.0]Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
maxdouble[0.0-1.0]Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
meandouble[0.0-1.0]Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mediandouble[0.0-1.0]Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDevdouble[0.0-1.0]Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
countintegern/aThe number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

FieldData TypeUnitsNotes
mindoublebytesMinimal value of memory usage sampled over the monitored period
maxdoublebytesMaximal value of memory usage sampled over the monitored period
meandoublebytesMean value of memory usage sampled over the monitored period
mediandoublebytesMedian value of memory usage sampled over the monitored period
stdDevdoublebytesStandard deviation of memory usage sampled over the monitored period
countintegern/aThe number of collected samples over the monitored period

vpnProfile object has the following properties:

FieldData TypeNotes
vpnClientAddressesarrayList of private IP addresses that the VPN server assigned to the device
vpnClientNetworkRangearrayList of private networks that the VPN server assigned to the device
vpnGatewayAddressstringIP address of the VPN gateway
vpnTypestringName of the VPN provider. For example, “CiscoAnyConnect” or “ZscalerInternet”

asnDetails object has the following properties:

FieldData TypeNotes
asNamestringname of the provider. For example, “ThousandEyes, Inc.”
asNumberlongunique number assigned to an organization(also referred to as service provider)

Example

$ curl https://api.thousandeyes.com/v6/endpoint-data/automated-session-tests/net/path-vis/273.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Wed, 29 Aug 2018 14:01:39 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 239 X-Organization-Rate-Limit-Reset: 1535551320 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-3

Body

{ "endpointAutomatedSessionTestNet": { "automatedSessionTest": {...}, "pathVis": [ { "agentId": "1cf6d996-2400-4724-a805-2de78756c209", "endpoints": [ { "ipAddress": "185.199.111.153", "numberOfHops": 8, "pathId": "8498006760529413427021933451903980591243082534558334817588690338427397277769705862118603451313420092120640807102236650497915440", "responseTime": 5 } ], "location": "San Francisco Area", "permalink": "https://app.thousandeyes.com/view/endpoint-agent?__a=160&scenarioId=eyebrowNetworkTest&testId=273&roundId=1535550480", "roundId": 1535550480, "server": "developer.thousandeyes.com:443", "serverIp": "185.199.111.153", "sourceIp": "10.100.10.35", "sourcePrefix": "38.122.6.64/30", "webex": { "conferenceId": "225817074608419375" "correlationId": "22581707460321454" }, "application": "WEBEX", "systemMetrics": { "startTimeMs": 1581508857327, "endTimeMs": 1581508867333, "cpuUtilization": { "min": 0.30859375, "max": 0.5625, "mean": 0.38931831001805056, "median": 0.353515625, "stdDev": 0.08389194281742307, "count": 10 }, "physicalMemoryUsedBytes": { "min": 1.2805128192E10, "max": 1.2825530368E10, "mean": 1.281914582109091E10, "median": 1.2818219008E10, "stdDev": 5741124.05691331, "count": 11 }, "physicalMemoryTotalBytes": 17069891584 }, "vpnProfile": { "vpnType": "CiscoAnyConnect", "vpnGatewayAddress": "144.254.221.38" }, "asnDetails": { "asNumber": 394101, "asName": "ThousandEyes, Inc." } }, ... ] }, "pages": { "current": 1 } }

For more information on our HTTP response status codes, see the response status codes documentation.

GET /v6/endpoint-data/automated-session-tests/net/path-vis/{testId}/{agentId}/{roundId} Automated Session Tests Detailed path trace

Returns a hop-by-hop summary of the path trace data collected during path visualization. In each round, one path discovery attempt is made to reach the destination. The entire path is returned. A roundId must be specified.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

Required parameters:

  • {testId} the ID of the test you wish to retrieve
  • {agentId} the ID of the endpoint agent from which you wish to obtain data
  • {roundId} the round ID for which you wish to obtain data. Equals the beginning of the testing round, in epoch time format.
  • There is no request body for this request.

Response

  • Each route should start with a hop of 1
  • Where a hop number is missing from response data, this is an indication that a star (*) response was returned in the path trace attempt for that hop.
FieldData TypeUnitsNotes
agentIdintegern/aUnique ID of agent, from /endpoint-agents endpoint
asnDetailsobjectn/aContains ASN information
permalinkurln/aLink to jump to this result in the front end
roundIdlongsecondsEpoch time (seconds) indicating the start time of the round
serverurln/aTarget server, including port
serverIpstringn/aIP address of target server
sourceIpstringn/aIP address of source endpoint agent
sourcePrefixstringn/aIP prefix of source agent
routesarrayn/aShows an iteration of path trace, with each iteration specified by a pathId
routes.pathIdstringn/aUnique ID of path trace
routes.hopsarrayn/aArray of hop objects indicating each step in the traceroute
routes.hops.hopintegern/aIndex of hop
routes.hops.ipAddressstringn/aIP address of the hop
routes.hops.prefixstringn/aPrefix of IP address shown in CIDR
routes.hops.rdnsstringn/aReverse DNS entry of IP, if available
routes.hops.networkstringn/aAutonomous System originating the prefix
routes.hops.responseTimeintegermillisecondsRTT to the hop’s IP
routes.hops.locationstringn/aLocation information for the hop
systemMetricsobjectn/aContains system metrics such as CPU and physical memory usage
vpnProfileobjectn/aContains information about the currently active VPN

systemMetrics object has the following properties:

FieldData TypeUnitsNotes
startTimeMsintegermillisecondsTime at which metrics collection started, as milliseconds since the Epoch
endTimeMsintegermillisecondsTime at which metrics collection ended, as milliseconds since the Epoch
cpuUtilizationobjectn/aContains utilization of the system’s processors over the monitored period
physicalMemoryUsedBytesobjectn/aContains metrics about used physical memory
physicalMemoryTotalBytesintegerbytesTotal physical memory of the system

cpuUtilization object has the following properties:

FieldData TypeUnitsNotes
mindouble[0.0-1.0]Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
maxdouble[0.0-1.0]Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
meandouble[0.0-1.0]Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mediandouble[0.0-1.0]Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDevdouble[0.0-1.0]Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
countintegern/aThe number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

FieldData TypeUnitsNotes
mindoublebytesMinimal value of memory usage sampled over the monitored period
maxdoublebytesMaximal value of memory usage sampled over the monitored period
meandoublebytesMean value of memory usage sampled over the monitored period
mediandoublebytesMedian value of memory usage sampled over the monitored period
stdDevdoublebytesStandard deviation of memory usage sampled over the monitored period
countintegern/aThe number of collected samples over the monitored period

vpnProfile object has the following properties:

FieldData TypeNotes
vpnClientAddressesarrayList of private IP addresses that the VPN server assigned to the device
vpnClientNetworkRangearrayList of private networks that the VPN server assigned to the device
vpnGatewayAddressstringIP address of the VPN gateway
vpnTypestringName of the VPN provider. For example, “CiscoAnyConnect” or “ZscalerInternet”

asnDetails object has the following properties:

FieldData TypeNotes
asNamestringname of the provider. For example, “ThousandEyes, Inc.”
asNumberlongunique number assigned to an organization(also referred to as service provider)

Example

$ curl https://api.thousandeyes.com/v6/endpoint-data/automated-session-tests/net/path-vis/273/1cf6d996-2400-4724-a805-2de78756c209/1535551380.json \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Wed, 29 Aug 2018 14:08:20 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Cache-Control: no-store X-Organization-Rate-Limit-Limit: 240 X-Organization-Rate-Limit-Remaining: 239 X-Organization-Rate-Limit-Reset: 1535551740 Strict-Transport-Security: max-age=31536000 X-Content-Type-Options: nosniff X-Server-Name: 1-5

Body

{ "endpointAutomatedSessionTestNet": { "automatedSessionTest": {...}, "pathVis": [ { "agentId": "1cf6d996-2400-4724-a805-2de78756c209", "permalink": "https://app.thousandeyes.com/view/endpoint-agent?__a=160&scenarioId=eyebrowNetworkTest&testId=273&roundId=1535551380", "roundId": 1535551380, "routes": [ { "hops": [ { "hop": 1, "ipAddress": "10.100.10.1", "rdns": "vlan10.fw1.sfo1.o.thousandeyes.com", "responseTime": 3 }, { "hop": 2, "ipAddress": "38.122.6.65", "location": "San Francisco, California, US", "network": "Cogent Communications (AS 174)", "prefix": "38.0.0.0/8", "rdns": "gi0-0-0-4.nr11.b001920-0.sfo01.atlas.cogentco.com", "responseTime": 4 }, { "hop": 3, "ipAddress": "154.24.7.73", "location": "San Francisco, California, US", "network": "Cogent Communications (AS 174)", "prefix": "154.24.0.0/13", "rdns": "gi0-0-0-6.agr22.sfo01.atlas.cogentco.com", "responseTime": 3 }, { "hop": 4, "ipAddress": "154.54.30.221", "location": "San Francisco, California, US", "network": "Cogent Communications (AS 174)", "prefix": "154.48.0.0/12", "rdns": "be2905.ccr22.sfo01.atlas.cogentco.com", "responseTime": 4 }, { "hop": 5, "ipAddress": "154.54.0.178", "location": "San Jose, California, US", "network": "Cogent Communications (AS 174)", "prefix": "154.48.0.0/12", "rdns": "be2016.ccr31.sjc04.atlas.cogentco.com", "responseTime": 4 }, { "hop": 6, "ipAddress": "62.115.34.73", "location": "San Jose, California, US", "network": "TeliaNet Global Network (AS 1299)", "prefix": "62.115.0.0/16", "rdns": "palo-b1-link.telia.net", "responseTime": 6 }, { "hop": 8, "ipAddress": "185.199.111.153", "location": "San Jose, California, US", "network": "Fastly (AS 54113)", "prefix": "185.199.111.0/24", "rdns": "185.199.111.153", "responseTime": 4 } ], "pathId": "8498006760529413427021933451903980591243082534558334817588690338427397277769705862118603451313420092120640807102237745714575920" } ], "server": "developer.thousandeyes.com:443", "serverIp": "185.199.111.153", "sourceIp": "10.100.10.35", "sourcePrefix": "38.122.6.64/30", "systemMetrics": { "startTimeMs": 1581508857327, "endTimeMs": 1581508867333, "cpuUtilization": { "min": 0.30859375, "max": 0.5625, "mean": 0.38931831001805056, "median": 0.353515625, "stdDev": 0.08389194281742307, "count": 10 }, "physicalMemoryUsedBytes": { "min": 1.2805128192E10, "max": 1.2825530368E10, "mean": 1.281914582109091E10, "median": 1.2818219008E10, "stdDev": 5741124.05691331, "count": 11 }, "physicalMemoryTotalBytes": 17069891584 }, "vpnProfile": { "vpnType": "CiscoAnyConnect", "vpnGatewayAddress": "144.254.221.38" }, "asnDetails": { "asNumber": 394101, "asName": "ThousandEyes, Inc." } } ] } }

For more information on our HTTP response status codes, see the response status codes documentation.

© 2023 ThousandEyes. All rights reserved.