Skip to content

Audit Log

Audit log is a list of changes for an entity. Each change is represented by the previous value (oldBody) and a new value (newBody) of a changed field.

Audit log model

Field Type Description
entityId String The ID of the modified entity.
entityType Integer A type of the modified entity. See EntityTypes for a list of entity types.
kind Integer A type of the modification. See EntityTypes for a list of entity types.
newBody Object New value of the entity's modified field.
oldBody Object Previous value of the entity's modified field.
timestamp Integer A timestamp of the entity modification.
userId String The ID of the user who modified an entity.

Difference between entityType and kind

The entityType field refers to the type of entity that's being modified. The kind field is a type of field of this entity, that's being modified. Both of these are EntityTypes.

The examples of audit logs with different entityType and kind values:

User modified a Property ("kind": 10) of an Object ("entityType": 1):

[
  {
    "entityType": 1,
    "kind": 10,
    ...
  },
   ...
]

User modified a Property ("kind": 10) of a Link ("entityType": 2):

[
  {
    "entityType": 2,
    "kind": 10,
    ...
  },
   ...
]

User modified a Session ("kind": 13) of a User ("entityType": 5).

[
  {
    "entityType": 5,
    "kind": 13,
    ...
  },
   ...
]