ThousandEyes API v6
ThousandEyes API v6

(Network) Path Visualization

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/net/path-vis/{testId}

Returns a summary of the path visualization data collected from each agent to the destination. In each path visualization attempt, three attempts are 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 current round of data 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
  • direction=[FROM_TARGET, TO_TARGET] Applicable only for bidirectional Agent-to-Agent tests, specifies the direction for the metrics being retrieved. If available, bidirectional data is returned by default.

Request

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

Response

Field Data Type Units Notes
agentId integer n/a unique ID of agent, from /agents endpoint
agentName string n/a display name of the agent responding
countryId string n/a ISO-3166-1 alpha-2 country code of the agent
date dateTime n/a yyyy-MM-dd hh:mm:ss, in UTC
roundId long seconds epoch time (seconds) indicating the start time of the round
permalink url n/a link to jump to this result in the front end
server url n/a target server, including port (if method used is TCP)
serverIp string n/a ip address of target server
sourceIp string n/a ip address of source agent
sourcePrefix string n/a ip prefix of source agent
endpoints array n/a shows all iterations of path trace, with each iteration specified by a pathId
endpoints.numberOfHops integer n/a number of hops for path trace to destination
endpoints.ipAddress string n/a destination
endpoints.pathId string n/a unique ID of path trace
endpoints.responseTime integer n/a RTT of the path trace to the destination

Example

curl
Copy$ curl https://api.thousandeyes.com/v6/net/path-vis/817.json \
  -u {email}:{authToken}
Code Snippet
CopyHTTP/1.1 200 OK
Server: nginx
Date: Wed, 26 Apr 2017 18:31:00 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-store
X-Organization-Rate-Limit-Limit: 240
X-Organization-Rate-Limit-Remaining: 234
X-Organization-Rate-Limit-Reset: 1493231520
Strict-Transport-Security: max-age=31536000
X-Server-Name: 1-3

Body

json
Copy{
    "net": {
        "test": {
            "enabled": 1,
            "testId": 817,
            "testName": "http://www.thousandeyes.com",
            "type": "http-server",
            "interval": 900,
            "url": "http://www.thousandeyes.com",
            "modifiedDate": "2013-05-11 02:02:21",
            "networkMeasurements": 1,
            "createdBy": "API Sandbox User (noreply@thousandeyes.com)",
            "modifiedBy": "API Sandbox User (noreply@thousandeyes.com)",
            "createdDate": "2012-06-28 19:33:12",
            "apiLinks": [...]
        },
        "pathVis": [
            {
                "agentName": "Hong Kong",
                "countryId": "HK",
                "date": "2013-11-13 02:47:46",
                "server": "www.thousandeyes.com:80",
                "serverIp": "50.18.127.223",
                "sourceIp": "123.103.248.179",
                "sourcePrefix": "123.103.248.0/24",
                "permalink": "https://app.thousandeyes.com/net/path-vis?__a=75&testId=817&roundId=1384310700&serverId=71&agentId=12",
                "agentId": 12,
                "endpoints": [
                    {
                        "numberOfHops": 16,
                        "ipAddress": "50.18.127.223",
                        "responseTime": 167,
                        "pathId": "6537222451557817610263112715264"
                    },
                    {
                        "numberOfHops": 16,
                        "ipAddress": "50.18.127.223",
                        "responseTime": 167,
                        "pathId": "6537222451557817610263112715265"
                    },
                    {
                        "numberOfHops": 16,
                        "ipAddress": "50.18.127.223",
                        "responseTime": 167,
                        "pathId": "6537222451557817610263112715266"
                    }
                ],
                "roundId": 1384310700
            },
            ...
        ]
    },
    "pages": {
        "current": 1
    }
}

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

Next