Get path visualization test results by agent and round
GET {{baseUrl}}/test-results/:testId/path-vis/agent/:agentId/round/:roundId?aid=1234&direction=to-target
Returns a summary of the path trace data collected during path visualization for a given agent and round. With each attempt, three tries are made to reach the destination. The entire path is displayed in order.
Bidirectional agent-to-agent tests also support the direction parameter. For example, if agents A, B, and C are testing agent D bidirectionally, and you want results from the route from agent A to agent D, you can use the query direction=to-target. For results from agent D to agent A, you can use direction=from-target. To get both results for both routes, query without the direction parameter. The source will always be agent A and the destination will be agent D, but the direction field will indicate which trace direction you want test results from.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
aid | number | 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. | |
direction | string | Choose the direction for the metrics you want: [from-target, to-target]. This applies when you're doing bidirectional Agent-to-Agent tests. Omitting the parameter will default the results to both from-target and to-target values (bidirectional); otherwise, you'll get data for one direction. If you try to get unidirectional test data with an incorrect direction parameter, it will trigger an error response. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"date":"2022-07-17T22:00:54Z","roundId":1384309800,"_links":{"appLink":{"href":"https://app.thousandeyes.com/view/tests?__a=105\u0026testId=195\u0026roundId=1692916680\u0026agentId=125"}},"startTime":1384309800,"endTime":1384309800,"agent":{"agentId":"281474976710706","agentName":"thousandeyes-stg-va-254","countryId":"US","location":"San Francisco Bay Area"},"server":"www.google.com:443","serverIp":"172.217.170.68","sourceIp":"196.40.106.237","sourcePrefix":"196.40.96.0/20","targetIsProxy":true,"direction":"to-target","pathTraces":[{"pathId":"4711301366345855606023718047703941305741293841502186803","hops":[{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"exercitation aliqua"},{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"esse proident "}]},{"pathId":"4711301366345855606023718047703941305741293841502186803","hops":[{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"in pariatur"},{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"amet cillum labore eu"}]}]},{"date":"2022-07-17T22:00:54Z","roundId":1384309800,"_links":{"appLink":{"href":"https://app.thousandeyes.com/view/tests?__a=105\u0026testId=195\u0026roundId=1692916680\u0026agentId=125"}},"startTime":1384309800,"endTime":1384309800,"agent":{"agentId":"281474976710706","agentName":"thousandeyes-stg-va-254","countryId":"US","location":"San Francisco Bay Area"},"server":"www.google.com:443","serverIp":"172.217.170.68","sourceIp":"196.40.106.237","sourcePrefix":"196.40.96.0/20","targetIsProxy":true,"direction":"to-target","pathTraces":[{"pathId":"4711301366345855606023718047703941305741293841502186803","hops":[{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"non incididunt quis labore"},{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"ut laborum nisi"}]},{"pathId":"4711301366345855606023718047703941305741293841502186803","hops":[{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"al"},{"hop":1,"ipAddress":"196.40.106.237","prefix":"196.40.96.0/20","rdns":"core-router1.cpt2.host-h.net","network":"HETZNER (Pty) Ltd (AS 37153)","responseTime":1,"location":"Cape Town, South Africa","mpls":"eiusmod "}]}]}],"test":{"interval":60,"alertsEnabled":true,"enabled":true,"createdBy":"user@user.com","createdDate":"2022-07-17T22:00:54Z","description":"ThousandEyes Test","liveShare":false,"modifiedBy":"user@user.com","modifiedDate":"2022-07-17T22:00:54Z","savedEvent":false,"testId":"281474976710706","testName":"ThousandEyes Test","type":"agent-to-server","_links":{"self":{"href":"https://api.thousandeyes.com/v7/tests/{type}/281474976710706"},"testResults":[{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/network"},{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/path-vis"}]}},"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"sed laborum aute","deprecation":"adipisicing deserunt nulla in ut","name":"Duis id","profile":"ut dolore tempor","title":"nisi esse aute","hreflang":"velit nostrud ex dolor irure"}}}