List account activity

GEThttps://api.checkslip.com/api/audit/events

API key

What happened on the account, newest first, such as API keys created or revoked, members invited or removed, and role changes. Each row says who acted (actor_type), through which channel (channel), on what (target_type, target_id), the value before and after, and the result: SUCCESS, FAILURE or DENIED. Filter action by its full name, or end it with .* for a whole group, e.g. api_key.*. Defaults to the last 24 hours; at most 31 days per call. Use next_cursor for the next page; there is no total. Uses no credit. Needs an API key with audit:read, or the web app sign-in.

Parameters

FieldInTypeRequired
fromquerystring (date-time)no
toquerystring (date-time)no
actionquerystringno
actor_typequeryUSER | API_KEY | ASSISTANT | STAFF | SYSTEMno
actor_idquerystring (uuid)no
channelqueryAPI | DASHBOARD | ASSISTANT | STAFF | SYSTEMno
target_typequerystringno
target_idquerystringno
cursorquerystringno
limitqueryintegerno

Responses

200 application/json

FieldTypeRequired
itemsAuditEventRecord[]yes
items[].event_idstring (uuid)yes
items[].categoryMONEY | ACCESS | DATA_CHANGE | SENSITIVE_READ | SECURITYyes
items[].outcomeSUCCESS | FAILURE | DENIEDyes
items[].occurred_atstring (date-time)yes
items[].request_idstring (uuid) | nullno
items[].actorobjectyes
items[].actor.typeUSER | API_KEY | ASSISTANT | STAFF | SYSTEMyes
items[].actor.idstring (uuid) | nullno
items[].actor.on_behalf_of_user_idstring (uuid) | nullno
items[].channelAPI | DASHBOARD | ASSISTANT | STAFF | SYSTEMyes
items[].actionstringyes
items[].targetobjectyes
items[].target.typestringyes
items[].target.idstringyes
items[].beforeobject | nullno
items[].afterobject | nullno
items[].reasonstring | nullno
items[].undo_of_event_idstring (uuid) | nullno
next_cursorstring | nullyes

Possible errors

400401403429

An error as Problem Details. All codes are listed at Error codes