Network: Detailed path trace

GET https://{{base_url}}/v6/net/path-vis/{{testId}}/{{agentId}}/{{roundId}}.json

(Network) Detailed path trace

Returns a hop-by-hop summary of the path trace data collected during path visualization. In each path visualization attempt, three attempts are made to reach the destination, and the entire path will be shown in sequence. A roundId must be specified. For agent-to-agent tests, there’s a special case to consider, since the test can be bidirectional.

Consider agents A, B and C testing agent D, on a bidirectional basis. To query for the route from agent A to agent D, query with testId/{agentA}/roundId?direction=TOTARGET. For the path from D to A, query with testId/{agentA}/roundId?direction=FROMTARGET. To get both paths, query the same endpoint with direction=BIDIRECTIONAL. In all cases, the source field will reflect agent A, and the destination field will reflect agent D, but the direction field will show the direction of the trace.

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 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.

Optional request parameter: * direction=[TOTARGET, FROMTARGET, BIDIRECTIONAL] indicates the direction of a path trace in the case of a bidirectional agent-to-agent test. This parameter is only applied in the case of bidirectional agent-to-agent tests. Specify the value on the querystring. Without specifying the field, the test will use the default direction for the test, which is chosen based on the following list: * BIDIRECTIONAL (shows both TOTARGET and FROMTARGET directions) * TOTARGET (shows path from source agent to target agent) * FROMTARGET (shows path from target agent to source agent)

HEADERS