Get a list of events

get/events
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
category
string (StringFilterParam)

Filter by event category

Example: category=xyz | in:x,y | like:xyz
action
string (StringFilterParam)

Filter by the action in the event.

Example: action=xyz | in:x,y | like:xyz
createdFrom
required
string (DateTimeFilterParam)

Filter by events created after this timestamp

Example: createdFrom=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
createdTo
required
string (DateTimeFilterParam)

Filter by events created before this timestamp

Example: createdTo=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "timestamp": "2019-08-24T14:15:22Z",
    • "category": "authentication",
    • "action": "user-login-success",
    • "description": "User bob.smith has logged in",
    • "username": "bob.smith",
    • "ipAddress": "12.34.56.78"
    }
]