API request events
Occurs on every API request made to Omni. Event type:API_REQUEST
string
The API path that was called (e.g.,
/api/v1/query/run).string
The type of the event. This will be
API_REQUEST.string
Audit log marker. This will be
AUDIT.string
The HTTP method used (e.g.,
GET, POST).string
The unique identifier for the Omni organization.
string
The HTTP response status code as a string (e.g.,
"200", "403").string
Whether the request succeeded, as a string. Either
"true" or "false".string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Query context events
Occurs when a user loads a document (workbook or dashboard). Event type:QUERY_CONTEXT
string
The unique ID of the workbook or dashboard within Omni, found within the URL for the document.
string
If applicable, the value will be the value of the entity field in an embed URL generated for a user.
string
The type of the event. This will be
QUERY_CONTEXT.string
Additional detail passed from the log.
string
The unique identifier for the Omni organization.
string
The unique identifier for the Omni user associated with the event.
number
The maximum number of query execution events that a query context event can trigger. Can be used to calculate cache hit rate as the denominator.
string
The URL of the page where the event was issued.
string
The source of the query context event. Possible values:
DASHBOARDWORKBOOKQUERY_DOWNLOADSUGGESTIONSSUMMARY_VALUESAI_FETCH_FIELD_VALUES
string
The first 6 characters of this field are overwritten with
stdout in delivered audit logs (e.g., DASHBOARD becomes stdoutARD). The query_source field contains the correct uncorrupted value. This field is retained for backwards compatibility only.string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries. For example, from a query context or dashboard download event to the query execution events that were subsequently run.
string
The URL of the page where the event occurred.
Query execution events
Occurs when a user runs a query, which may be sent back to the warehouse. Event type:QUERY_EXECUTE
string
The time the event occurred.
number
The total length of query execution within the warehouse.
string
The type of the event. This will be
QUERY_EXECUTE.string
The ID of the corresponding job in the warehouse where the query was executed.
string
Detail passed from the infrastructure back to the user, if applicable.
string
A uuid for the query being executed within Omni. Used for query killing purposes.
string
The unique identifier for the Omni organization.
string
The query that was executed.
string
A uuid that can be used to trace the event across other log entries. For example, from a query context or dashboard download event to the query execution events that were subsequently run.
boolean
Indicates if the query executed successfully. Note: This doesn’t indicate the success of the job, only the individual query.
Dashboard download events
Occurs when a user downloads a full dashboard. Event type:DASHBOARD_DOWNLOAD
string
The unique ID of the workbook or dashboard within Omni, found within the URL for the document.
string
If applicable, the value will be the value of the entity field in an embed URL generated for a user.
string
The type of the event. This will be
DASHBOARD_DOWNLOAD.string
Additional detail passed from the log.
string
The unique identifier for the Omni organization.
string
The unique identifier for the Omni user associated with the event.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries. For example, from a query context or dashboard download event to the query execution events that were subsequently run.
string
The URL of the page where the event occurred.
User invite events
Occurs when a new user is invited to the organization. Event type:USER_INVITE
string
The type of the event. This will be
USER_INVITE.string
The ID of the invited user.
string
Additional detail passed from the log.
string
The unique identifier for the Omni organization.
string
The unique identifier for the Omni user associated with the event.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Connection events
Connection created
Occurs when a new data connection is created. Event type:CREATE_CONNECTION
object
Details about the Omni user associated with the event.
string
The ID of the connection that was created.
string
The warehouse dialect for the connection (e.g.,
BIGQUERY, SNOWFLAKE, POSTGRES).string
The type of the event. This will be
CREATE_CONNECTION.string
A JSON object of the connection’s non-sensitive field values at creation time. Sensitive fields (credentials, keys, secrets) are redacted.
string
The name of the connection.
string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Connection updated
Occurs when a data connection’s settings are modified. Event type:UPDATE_CONNECTION
object
Details about the Omni user associated with the event.
string
A comma-separated list of field names that were changed.
string
A JSON object mapping each changed field name to a
from and to value. Sensitive fields (credentials, keys, secrets) are redacted on both sides.string
The ID of the connection that was updated.
string
The warehouse dialect for the connection.
string
The type of the event. This will be
UPDATE_CONNECTION.string
The name of the connection.
string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Connection deleted
Occurs when a data connection is deleted (archived). Event type:DELETE_CONNECTION
object
Details about the Omni user associated with the event.
string
The ID of the connection that was deleted.
string
The warehouse dialect for the connection.
string
The type of the event. This will be
DELETE_CONNECTION.string
The name of the connection.
string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Connection restored
Occurs when a previously deleted connection is restored. Event type:RESTORE_CONNECTION
object
Details about the Omni user associated with the event.
string
The ID of the connection that was restored.
string
The warehouse dialect for the connection.
string
The type of the event. This will be
RESTORE_CONNECTION.string
The name of the connection.
string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Connection base role updated
Occurs when the base role for a connection changes. Event type:UPDATE_CONNECTION_BASE_ROLE
object
Details about the Omni user associated with the event.
string
The ID of the connection associated with the role change.
string
The type of the event. This will be
UPDATE_CONNECTION_BASE_ROLE.string
Additional detail passed from the log.
string
The name of the updated base connection role.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Connection credentials updated
Occurs when credentials (password, private key) are rotated on a connection. Event type:UPDATE_CONNECTION_CREDENTIALS
object
Details about the Omni user associated with the event.
string
The ID of the connection whose credentials were updated.
string
A comma-separated list of credential types that were updated. Possible values include
password and privateKey. Credential values are never included in the audit log.string
The type of the event. This will be
UPDATE_CONNECTION_CREDENTIALS.string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Organization action events
Delivery personalization updated
Occurs when the organization’s Delivery personalization setting is changed. Event type:UPDATE_DELIVERY_PERSONALIZATION_MODE
string
The type of the event. This will be
UPDATE_DELIVERY_PERSONALIZATION_MODE.string
The updated value of the setting. This will be one of
configurable, always, or never.string
The unique identifier for the Omni organization.
string
The number of deliveries updated as a result of the change.
Role events
Organization role updated
Occurs when a user’s organization-level role changes. Event type:UPDATE_ORGANIZATION_ROLE
object
Details about the Omni user associated with the event.
string
The type of the event. This will be
UPDATE_ORGANIZATION_ROLE.string
The ID of the organization membership record for the user whose role changed.
string
The unique identifier for the Omni organization.
string
The name of the new organization role.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
User model role updated
Occurs when a user’s model-level role changes. Event type:UPDATE_USER_MODEL_ROLE
object
Details about the Omni user associated with the event.
string
The type of the event. This will be
UPDATE_USER_MODEL_ROLE.string
The ID of the model associated with the role change.
string
The unique identifier for the Omni organization.
string
The name of the new model role.
string
The membership ID of the user whose role was updated.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
User group model role updated
Occurs when a user group’s model-level role changes. Event type:UPDATE_GROUP_MODEL_ROLE
object
Details about the Omni user associated with the event.
string
The ID of the connection associated with the role change.
string
The type of the event. This will be
UPDATE_GROUP_MODEL_ROLE.string
The ID of the model associated with the role change.
string
The unique identifier for the Omni organization.
string
The name of the new model role.
string
The ID of the user group whose role was updated.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Custom role created
Occurs when a custom role is created. Event type:CREATE_CUSTOM_ROLE
object
Details about the Omni user associated with the event.
string
The built-in role the custom role is based on.
string
The display name of the custom role.
string
The type of the event. This will be
CREATE_CUSTOM_ROLE.string
The internal name of the custom role.
string
The unique identifier for the Omni organization.
string
The ID of the newly created custom role.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Custom role updated
Occurs when a custom role’s definition is modified. Event type:UPDATE_CUSTOM_ROLE
object
Details about the Omni user associated with the event.
string
The built-in role the custom role is based on. Present when the base role has not changed.
string
The previous base role. Present only when the base role changed.
string
The new base role. Present only when the base role changed.
string
The display name of the custom role.
string
The type of the event. This will be
UPDATE_CUSTOM_ROLE.string
The internal name of the custom role.
string
The unique identifier for the Omni organization.
string
The ID of the custom role.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Custom role deleted
Occurs when a custom role is deleted. Event type:DELETE_CUSTOM_ROLE
object
Details about the Omni user associated with the event.
string
The built-in role the custom role was based on.
string
The display name of the custom role.
string
The type of the event. This will be
DELETE_CUSTOM_ROLE.string
The internal name of the custom role.
string
The unique identifier for the Omni organization.
string
The ID of the deleted custom role.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Custom role reordered
Occurs when a custom role’s priority order is changed relative to another role. Event type:REORDER_CUSTOM_ROLE
object
Details about the Omni user associated with the event.
string
The built-in role the custom role is based on.
string
The type of the event. This will be
REORDER_CUSTOM_ROLE.string
The unique identifier for the Omni organization.
string
The internal name of the role being reordered.
string
The internal name of the role that
roleName is being positioned relative to.string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
Content permission events
Content permission granted
Occurs when a user or group is granted access to a document or folder. Event type:GRANT_CONTENT_PERMIT
string
The permission action granted (e.g.,
view, edit).object
Details about the Omni user associated with the event.
string
The ID of the document the permission was granted on, if applicable.
string
The type of the event. This will be
GRANT_CONTENT_PERMIT.string
The ID of the folder the permission was granted on, if applicable.
string
The unique identifier for the Omni organization.
string
The role granted.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
string
A comma-separated list of user group IDs the permission was granted to, if applicable.
string
A comma-separated list of user IDs the permission was granted to, if applicable.
string
The ID of the workbook the permission was granted on, if applicable.
Content permission revoked
Occurs when a user’s or group’s access to a document or folder is removed. Event type:REVOKE_CONTENT_PERMIT
object
Details about the Omni user associated with the event.
string
The ID of the document the permission was revoked on, if applicable.
string
The type of the event. This will be
REVOKE_CONTENT_PERMIT.string
The ID of the folder the permission was revoked on, if applicable.
string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
string
A comma-separated list of user group IDs whose permission was revoked, if applicable.
string
A comma-separated list of user IDs whose permission was revoked, if applicable.
string
The ID of the workbook the permission was revoked on, if applicable.
Content ownership transferred
Occurs when ownership of a document or folder is transferred from one user to another. Event type:TRANSFER_CONTENT_OWNERSHIP
object
Details about the Omni user associated with the event.
string
The ID of the document whose ownership was transferred, if applicable.
string
The type of the event. This will be
TRANSFER_CONTENT_OWNERSHIP.string
The ID of the folder whose ownership was transferred, if applicable.
string
The user ID of the new owner.
string
The unique identifier for the Omni organization.
string
The user ID of the previous owner.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
string
The ID of the workbook whose ownership was transferred, if applicable.
Embed membership events
Embed membership created
Occurs when an embedded user’s membership is created. Event type:CREATE_EMBED_MEMBERSHIP
object
Details about the Omni user associated with the event.
string
The type of the event. This will be
CREATE_EMBED_MEMBERSHIP.string
The ID of the newly created embed membership.
string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
string
The ID of the embedded user.
Embed membership deleted
Occurs when an embedded user’s membership is deleted. Event type:DELETE_EMBED_MEMBERSHIP
object
Details about the Omni user associated with the event.
string
The type of the event. This will be
DELETE_EMBED_MEMBERSHIP.string
The ID of the deleted embed membership.
string
The unique identifier for the Omni organization.
string
The time the event occurred.
string
A uuid that can be used to trace the event across other log entries.
string
The ID of the embedded user.