Sign in

v1

latestSwagger 2.02026-08-061,9128853.7 MB
Events

Get a list of events

A list of all audit events collected to date, ordered by the date of the event in descending order. Events can be filtered by various criteria and can be returned as a csv file when the optional parameter 'asCsv' is set to true.

get/events

Query parameters

asCsvboolean

Returns list of events as a csv file when set to true

documentTypesstring[]

The document types to be matched, provided as a comma separated list of strings

environmentsstring[]

The environment ids to be matched, provided as a comma separated list of strings

eventAgentsstring[]

The event agents to be matched, provided as a comma separated list of strings

eventCategoriesstring[]

The event categories to be matched, provided as a comma separated list of strings

eventGroupsstring[]

The event groups to be matched, provided as a comma separated list of strings

excludeDifferenceboolean

Omits the change details of all events when set to true

fromstring date-time

Filter events that occurred after this datetime

fromAutoIdinteger

Filter events after specified autoId

idsstring

The event ids to be matched, provided as a comma separated list of strings

includeInternalEventsboolean

Exclude the machine-related CRUD events that were added for auto-deploy events

projectGroupsstring[]

The project group ids to be matched, provided as a comma separated list of strings

projectsstring[]

The project ids to be matched, provided as a comma separated list of strings

regardingstring[]

The related document ids to be matched, provided as a comma separated list of strings

regardingAnystring[]

The related document ids to be matched, provided as a comma separated list of strings

skipinteger

Number of items to skip. Defaults to zero

tagsstring[]

The canonical tag ids to be matched, provided as a comma separated list of strings

takeinteger

Number of items to take. Defaults to 30

tenantsstring[]

The tenant ids to be matched, provided as a comma separated list of strings

tostring date-time

Filter events that occurred before this datetime

toAutoIdinteger

Filter events before specified autoId

userstring
usersstring[]

The user ids to be matched, provided as a comma separated list of strings

Response

OK