v6

latestOpenAPI 3.0.0raw.githubusercontent.com2024-10-187525179.6 KB

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
  }
}