UserEvents
Query the available Events in Box.
Table Specific Information
User events are logs that are saved after a change in a user's account.
Select
Query all the current user's events:
SELECT * FROM UserEvents
If you're authenticated as an administrator with user impersonation permissions, you can query user events from multiple user accounts:
SELECT * FROM UserEvents WHERE AsUserId IN (SELECT Id FROM Users)
Note: User impersonation has the following limitations:
- The authenticated user cannot be impersonated unless that user is a service account.
- If the authenticated user is a standard user account, they can only query user events associated with their account.
- User events shared with multiple users are only returned for one of the users.
Columns
Name | Type | Description |
Id [KEY] | String | The Id of the event. |
SourceId | String | The Id of the source that triggered the event. |
SourceType | String | The type of the source that triggered the event. |
CreatedById | String | The Id of the user that created the event. |
CreatedByName | String | The Name of the user that created the event. |
CreatedByLogin | String | The Login of the user that created the event. |
CreatedAt | Datetime | The date the event was created at. This can only be used when requesting the events with a StreamType of admin_logs |
RecordedAt | Datetime | The date the event was recorded at. |
SessionId | String | The Id of the session of the event. |
EventType | String | The type of the event. |
ClassificationName | String | The classification name of the event. |
AdditionalDetails | String | This object provides additional information about the event if available. This can include how a user performed an event as well as additional information to correlate an event to external KeySafe logs. Not all events have an additional_details object. This object is only available in the Enterprise Events. |
AsUserId | String | The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StreamType | String | The type of events to stream.
The allowed values are all, changes, sync, admin_logs, admin_logs_streaming. |