List events

get https://{hostname}/event-viewer-api/v1/events

Returns each user account's portal-visible events stored in the Event Logger system. The response format is determined by the Accept header. Supported formats are application/json and text/csv.

Query Params

eventTypeId

integer

The unique identifier for the event type. Use this parameter to view all events with the specified event type ID.

start

string

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

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

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

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

The name of the user that created the event. Use this parameter to view all events generated by the specified user.

limit

integer

Limits the set of results. The maximum limit is 50 for application/json, and 1000 for text/csv.

accountSwitchKey

string

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.

Response

Response body

object

events

array of objects

required

Provides information about the event.

events*

object

eventData

array of objects

The map of user-defined keys and values that describe additional event data.

eventData

object

key

string

A key that specifies the event data type. Note that it's not necessary to make keys in the array of objects unique. There may be objects in the array with the same key that represent a collection of the same type. For example, a list of CP codes with different values.

value

string

The value of a particular key.

eventId

string

The unique identifier for the event.

eventTime

string

The date and time of the event.

eventType

object

Provides information about the event type.

impersonator

boolean

Whether an impersonating user created the event.

username

string

The username of the user who created the event.

links

array of objects

required

Hypermedia links to help navigate through the result set, or to identify the current item whose rel is self, next, or prev.

links*

object

href

string

required

A relative path to the currently requested object or a specific page of the result set.

rel

string

required

The relationship between the current and linked result sets. A value of self links to the current result set, while prev and next link to different sets of data.

200Successful response.