Events

List all events

Events are an audit trail of important events that happen in the knowledge base.

post/events.list

Request body

offsetnumber

limitnumber

sortstring

direction'ASC' | 'DESC'

namestring

Filter to a specific event, e.g. "collections.create". Event names are in the format "objects.verb"

actorIdstring uuid

Filter to events performed by the selected user

documentIdstring uuid

Filter to events performed in the selected document

collectionIdstring uuid

Filter to events performed in the selected collection

auditLogboolean

Whether to return detailed events suitable for an audit log. Without this flag less detailed event types will be returned.

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

Example response

{
  "data": [
    {
      "name": "documents.create",
      "actorIpAddress": "60.169.88.100",
      "data": {
        "name": "Equipment list"
      },
      "actor": {
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

Changed in 2 of the 6 revisions of this API.7

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d6See the full diff
- ○
  added the optional property data to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added

Full history