Get API test results
GET {{baseUrl}}/test-results/:testId/api?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&cursor=
Returns test results for API. If you do not specify a window or a start and end date, data is displayed for the most recent testing round.
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. | |
window | string | A 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 . | |||
startDate | string | Use 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 . | |
endDate | string | Defaults 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 . | |
cursor | null | (Optional) Opaque cursor used for pagination. Clients should use next value from _links instead of this parameter. |
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"},"apiTransactionTime":990.1,"completion":100,"errorType":"None","errorDetails":"Connection error"},{"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"},"apiTransactionTime":990.1,"completion":100,"errorType":"None","errorDetails":"Connection error"}],"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":false,"type":"nisi dolore culpa cupidatat","deprecation":"adipisicing ipsum qui Lorem","name":"aute occaecat","profile":"voluptate culpa","title":"reprehenderit","hreflang":"minim sint cup"},"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"pariatur fugiat ipsum sunt","deprecation":"dolor Ut reprehenderi","name":"Lorem sed","profile":"ipsum sed ullamco dolor","title":"commodo proident","hreflang":"voluptate sit laborum pariatur dolore"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"ea quis reprehenderit pariatur","deprecation":"fugiat nisi","name":"culpa labore eiusmod occaecat","profile":"in esse","title":"cupidatat ut ut aliquip","hreflang":"adipisicing reprehenderit ut"}}}