List events
GET https://{{host}}/event-viewer-api/v1/events
Returns each user account's portal-visible events stored in the Event Logger system. Each page of results lists 50 events. You can move between pages using the afterEventId and beforeEventId query parameters, or follow the relevant hypermedia link at the bottom of each page.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
eventTypeId | string | (Optional) The unique identifier for the event type. Use this parameter to view all events with the specified event type ID. | |
start | string | (Optional) The start date and time of the event. Use this parameter to view all events that occurred after the specified date and time. | |
end | string | (Optional) The end date and time of the event. Use this parameter to view all events that occurred before the specified date and time. | |
afterEventId | string | (Optional) The unique identifier for the event. Use this parameter to view all events that occurred after the event with the specified event ID. | |
beforeEventId | string | (Optional) The unique identifier for the event. Use this parameter to view all events that occurred before the event with the specified event ID. | |
username | string | (Optional) The name of the user that created the event. Use this parameter to view all events generated by the specified user. | |
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"events":[{"eventData":[],"eventId":"b5ac4d16-8223-4cbd-86f3-f42f52a8f6ff","eventTime":"2017-07-27T12:13:37.15Z","eventType":{"eventDefinition":{"eventDefinitionId":"415195","eventDescription":"A user logged in.","eventName":"Login"},"eventTypeId":"16","eventTypeName":"All Logins"},"impersonator":true,"username":"jperez"},{"eventData":[{"key":"Email To","value":"aaa@akamai.com"},{"key":"Start Time","value":"Thu, Jul 27, 12:13 GMT 2017"}],"eventId":"5409ed6f-d532-4832-b2be-961a21380416","eventTime":"2017-07-27T12:13:10.426Z","eventType":{"eventDefinition":{"eventDefinitionId":"169758","eventDescription":"The condition that this alert was set up to monitor has occurred.","eventName":"Alert Fired"},"eventTypeId":"50","eventTypeName":"Alert Activity"},"impersonator":false,"username":"szhang"}],"links":[{"href":"/event-viewer-api/v1/events?beforeEventId=038a9f69-121f-4248-acd2-74103012c680","rel":"next"},{"href":"/event-viewer-api/v1/events?afterEventId=68bb2c73-bf1b-4cb0-ae56-b4fcd7210317","rel":"prev"},{"href":"/event-viewer-api/v1/events","rel":"self"}]}