Qodex.ai

List endpoint real user tests

POST {{baseUrl}}/endpoint/test-results/real-user-tests/networks/filter?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&cursor=

Returns a list of all endpoint real user tests. Sessions from the last round are provided unless an explicit start and end is provided with startDate, endDate or window optional parameters.

Request body filters

This endpoint supports complex filtering using the request body. It is important these filters remain unaltered when making use of pagination, otherwise the results will not be coherent with the original request.

Multiple filter fields

When multiple filter fields are provided, a logical AND is applied between the filters. curl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/networks/filter' --header 'Authorization: Bearer $token' --header 'Content-Type: application/json' --data-raw '{ "searchFilters": { "platform": [ "mac" ], "domain": [ "thousandeyes.com" ] }}'

Filter field with multiple values

When a filter field contains multiple values, a logical OR is applied between the filter values. curl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/networks/filter' --header 'Authorization: Bearer $token' --header 'Content-Type: application/json' --data-raw '{ "searchFilters": { "networkId": [ "660b34109d12", "660b34109d15" ] }}'

Combination of request parameters and body filters

curl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/networks/filter?window=1w'
--header 'Authorization: Bearer $token'
--header 'Content-Type: application/json'
--data-raw '{
  "searchFilters": {
    "platform": [ "mac" ],
    "domain": [ "thousandeyes.com" ],
    "networkId": [ "660b34109d12", "660b34109d15" ]
  }}'

Returns a results array of endpoint real user tests. Network sessions shown are from the latest round, or based on the time range specified.

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.

Request Body

{"searchFilters"=>{"location"=>["San Francisco Bay Area", "Germany"], "connection"=>["wireless", "wireless"], "platform"=>["mac", "mac"], "gateway"=>["78.153.54.204", "78.153.54.206"], "proxyTarget"=>["78.153.54.204", "78.153.54.206"], "vpnTarget"=>["78.153.54.204", "78.153.54.206"], "agentId"=>["3fde6422-f119-40e1-ae32-d08a1243c038", "236e6f18-9637-4a2f-b15f-7aa6a29c9fce"], "networkId"=>["660b34109d12", "660b34109d15"], "ssid"=>["wifi-name", "other-room-wifi"], "bssid"=>["8c:68:c8:a5:0a:8c", "0c:51:01:e4:3e:d0"], "destinationIp"=>["84.255.241.1", "193.2.1.88"], "domain"=>["thousandeyes.com"], "trigger"=>["user"], "visitedSite"=>["app.thousandeyes.com"]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"results":[{"agentId":"861b7557-cd57-4bbb-b648-00bddf88ef49","date":"2022-07-17T22:00:54Z","id":"07625:1490529480:aVDViw0i","roundId":1384309800,"destination":{"jitter":46,"latency":150,"loss":0.1,"target":"54.208.6.220"},"vpn":{"jitter":46,"latency":150,"loss":0.1,"target":"54.208.6.220"},"proxy":{"jitter":46,"latency":150,"loss":0.1,"target":"54.208.6.220"},"systemMetrics":{"startTimeMs":1581508857327,"endTimeMs":1581508867333,"cpuUtilization":{"min":0.22,"max":0.75,"mean":0.55,"median":0.61,"stdDev":0.01,"count":150},"physicalMemoryUsedBytes":{"min":1.2,"max":2.5,"mean":1.77,"median":1.85,"stdDev":0.25,"count":155},"physicalMemoryTotalBytes":1024}},{"agentId":"861b7557-cd57-4bbb-b648-00bddf88ef49","date":"2022-07-17T22:00:54Z","id":"07625:1490529480:aVDViw0i","roundId":1384309800,"destination":{"jitter":46,"latency":150,"loss":0.1,"target":"54.208.6.220"},"vpn":{"jitter":46,"latency":150,"loss":0.1,"target":"54.208.6.220"},"proxy":{"jitter":46,"latency":150,"loss":0.1,"target":"54.208.6.220"},"systemMetrics":{"startTimeMs":1581508857327,"endTimeMs":1581508867333,"cpuUtilization":{"min":0.22,"max":0.75,"mean":0.55,"median":0.61,"stdDev":0.01,"count":150},"physicalMemoryUsedBytes":{"min":1.2,"max":2.5,"mean":1.77,"median":1.85,"stdDev":0.25,"count":155},"physicalMemoryTotalBytes":1024}}],"startDate":"2022-07-17T22:00:54Z","endDate":"2022-07-18T22:00:54Z","_links":{"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"non Duis qui sint","deprecation":"qui aliquip adipisicing occaecat et","name":"non sit repr","profile":"nostrud amet et","title":"cupidatat fugiat aute voluptate minim","hreflang":"in exercitation dolor"}}}