Events

Events document an action taken by a user in the system. They provide metadata about the action and a string representation suitable for display. You can list all events for a user or a file.

List all Events for a User

Lists all events for a user across all of their Workspaces.

Parameters

workspaces array of integers The [id] of the Workspace(s) to list events for.
verbs array of strings The action(s) taken in the events. Available verbs are create, upload, read, download, update, delete, and invite.
filter_self boolean Should the user’s own events be removed? Default is false.
actor integer The [id] of the user to list events for.
start_time timestamp The earliest time you would like to see events from. Timestamps should be specificed in RFC-2822 format and will assume the same time zone of the requesting user.
end_time timestamp The latest time you would like to see events from. Timestamps should be specificed in RFC-2822 format and will assume the same time zone of the requesting user.

Return

Returns a paged array of event objects and a 200 if the call succeeds.

List all Events for a File

Lists all events for a file specified via [id]. This resource is only available to users with a role of Moderator or above.

Return

Returns a paged array of event objects and a 200 if the call succeeds. Returns a 403 error with an error in the message body if the user has role lower than Moderator in the specified Workspace.