List events
GET {{baseUrl}}/events?aid=1234&window=12h&startDate=2022-07-17T22:00:54Z&endDate=2022-07-18T22:00:54Z&max=5&cursor=
Retrieves a list of events within the specified time window. If no events are active during the specified time range, an empty response is returned. Note: You must provide either a time window using the window parameter or specify startDate and endDate.
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. | |
max | number | (Optional) Maximum number of objects to return. | |
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
{"aid":"1234","startDate":"2022-07-17T22:00:54Z","endDate":"2022-07-18T22:00:54Z","events":[{"id":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","typeName":"Network Issue","state":"resolved","startDate":"2020-04-23T13:43:16Z","endDate":"2020-04-23T13:43:16Z","severity":"medium","title":"Affecting destinations in google.com","type":"target","affectedTests":{"total":5,"inAccountGroup":2},"affectedTargets":{"total":5,"inAccountGroup":2},"affectedAgents":{"total":5,"inAccountGroup":2},"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"do Excepteur nostrud","deprecation":"in dolore","name":"adipisicing mollit in velit","profile":"dolor ipsum quis dolore","title":"o","hreflang":"fugiat incididunt ipsum in"}}},{"id":"e9c3bf02-a48c-4aa8-9e5f-898800d6f569","typeName":"Network Issue","state":"resolved","startDate":"2020-04-23T13:43:16Z","endDate":"2020-04-23T13:43:16Z","severity":"medium","title":"Affecting destinations in google.com","type":"target","affectedTests":{"total":5,"inAccountGroup":2},"affectedTargets":{"total":5,"inAccountGroup":2},"affectedAgents":{"total":5,"inAccountGroup":2},"_links":{"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"incididunt ex","deprecation":"dolore reprehenderit do enim","name":"anim velit","profile":"fug","title":"esse nisi fugiat","hreflang":"ut aliqua sit dolore"}}}],"_links":{"next":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":false,"type":"incididunt aliquip minim ullamco","deprecation":"id esse tempor et","name":"nisi nulla ","profile":"sit cupidatat do ex","title":"esse consectetur commodo Duis","hreflang":"amet enim"},"self":{"href":"https://api.thousandeyes.com/v7/link/to/resource/id","templated":true,"type":"voluptate quis cillum ea","deprecation":"et minim","name":"qui laborum ","profile":"laboris aliquip ex sunt","title":"esse fugiat deserunt irure","hreflang":"ex"}}}