Qodex.ai

Get path visualization network test results

GET {{baseUrl}}/test-results/:testId/path-vis?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&cursor=&direction=to-target

Returns a summary of the path trace data collected during path visualization for a given time range. With each attempt, three tries are made to reach the destination. The entire path is displayed in order. If you do not specify a window or a start and end date, data is displayed for the most recent testing round.

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

KeyDatatypeRequiredDescription
aidnumberA 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.
windowstringA dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: s for seconds (default if no type is specified), m for minutes, h for hours, d for days, and w for weeks.
For a precise date range, use startDate and endDate.
startDatestringUse with the endDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
endDatestringDefaults to current time the request is made. Use with the startDate parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with window.
cursornull(Optional) Opaque cursor used for pagination. Clients should use next value from _links instead of this parameter.
directionstringChoose 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"results":[{"pathTraces":[{"ipAddress":"196.40.106.237","mss":1460,"numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","pathMtu":1500,"responseTime":1500},{"ipAddress":"196.40.106.237","mss":1460,"numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","pathMtu":1500,"responseTime":1500}],"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":[{"ipAddress":"196.40.106.237","mss":1460,"numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","pathMtu":1500,"responseTime":1500},{"ipAddress":"196.40.106.237","mss":1460,"numberOfHops":15,"pathId":"1230899668701775614109128428722974545787322404682781961521","pathMtu":1500,"responseTime":1500}],"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"}],"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"}]}},"startDate":"2022-07-17T22:00:54Z","endDate":"2022-07-18T22:00:54Z","_links":{"previous":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"sed Lorem ut nisi","deprecation":"d","name":"adipisicing eiusmod in eu voluptate","profile":"in dolor ea aute","title":"qui","hreflang":"enim consectetur dolore"},"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"amet","deprecation":"in ea proident tempor dolore","name":"fugiat","profile":"eiusmod minim mollit","title":"amet laborum culpa occaecat","hreflang":"elit adipisicing culpa laboris sed"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"incididunt enim","deprecation":"eu dolore","name":"nulla incidi","profile":"ea","title":"fugiat Duis Excepteur dolor","hreflang":"irure sit"}}}