ThousandEyes API v6

Scheduled Tests (Network) End-to-End metrics

ThousandEyes API v6 has been deprecated as of May 27, 2024. We strongly recommend that you migrate to ThousandEyes API v7 to ensure continued support and access to new features. For more information, see the deprecation notice.

GET /v6/endpoint-data/tests/net/metrics/{testId}

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.

Parameters

Querystring

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

Field	Data Type	Units	Notes
agentId	string	n/a	Unique ID of endpoint agent, from `/endpoint-agents` endpoint
avgLatency	float	milliseconds	Average RTT for packets sent to destination
errorDetails	string	n/a	Error details, if an error was encountered
jitter	float	milliseconds	Standard deviation of latency
loss	float	percentage	% of packets not reaching destination
maxLatency	integer	milliseconds	Maxmimum RTT for packets sent to destination
minLatency	integer	milliseconds	Minimum RTT for packets sent to destination
networkProfile	object	n/a	Contains basic network connectivity parameters, such as IP settings, DNS settings, NIC type, WiFi settings, Proxy settings
permalink	url	n/a	Link to jump to this result in the front end
roundId	long	seconds	Epoch time (seconds) indicating the start time of the round
serverIp	string	n/a	IP address of target server
systemMetrics	object	n/a	Contains system metrics such as CPU and physical memory usage

systemMetrics object has the following properties:

Field	Data Type	Units	Notes
startTimeMs	integer	milliseconds	Time at which metrics collection started, as milliseconds since the Epoch
endTimeMs	integer	milliseconds	Time at which metrics collection ended, as milliseconds since the Epoch
cpuUtilization	object	n/a	Contains utilization of the system's processors over the monitored period
physicalMemoryUsedBytes	object	n/a	Contains metrics about used physical memory
physicalMemoryTotalBytes	integer	bytes	Total physical memory of the system

cpuUtilization object has the following properties:

Field	Data Type	Units	Notes
min	double	[0.0-1.0]	Minimal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
max	double	[0.0-1.0]	Maximal value of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
mean	double	[0.0-1.0]	Mean of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
median	double	[0.0-1.0]	Median of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
stdDev	double	[0.0-1.0]	Standard deviation of CPU usage sampled (in range of [0.0-1.0]) over the monitored period
count	integer	n/a	The number of collected samples over the monitored period

physicalMemoryUsedBytes object has the following properties:

Field	Data Type	Units	Notes
min	double	bytes	Minimal value of memory usage sampled over the monitored period
max	double	bytes	Maximal value of memory usage sampled over the monitored period
mean	double	bytes	Mean value of memory usage sampled over the monitored period
median	double	bytes	Median value of memory usage sampled over the monitored period
stdDev	double	bytes	Standard deviation of memory usage sampled over the monitored period
count	integer	n/a	The number of collected samples over the monitored period

Example

curl

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

Code Snippet

CopyHTTP/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

json

Copy{
    "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.