Audit Logs
Track all important actions using our rich audit logs.
An audit log object provides information about the action and user that initiated the changes and the old and new values, where applicable.
The API allows you to retrieve audit logs for a given client, action, resource, or trigger.
The Audit Log object
Attribute | Type | Description |
---|---|---|
| string | The unique identifier for an audit log. |
| string | The team member whose actions triggered the audit log creation. |
| string | The type of audited resource. Valid values include:
|
| string | The id of the audited resource. |
| string | The id of the client associated with the audited resource. |
| string | The event that triggered the audit log creation, e.g. updateClient. |
| string | The type of action. Possible values are:
|
| array[object] | The diff between the old and new values of the audited resource. Also, see the diff object below. |
| string | The date and time when the audit log was created. |
The diff
object
diff
objectAttribute | Type | Description |
---|---|---|
| string | Indicates the kind of change. Possible values are:
|
| array[string] | The left-to-right path of the attribute in the audited resource e.g. |
| string | The old value of the audited attribute. |
| string | The new value of the audited attribute. When |
Last updated