THthoughtspot

Retrieve audit logs

Changed on

Returns a paginated list of audit log events for the given workspace.

get/{workspace}/audit_logs

Request

Path parameters

workspacestring required

Workspace username

Query parameters

start_timestampstring required

The start of the time range for audit logs (ISO 8601 format).

end_timestampstring required

The end of the time range for audit logs (ISO 8601 format).

actionstring

The type of action performed.

entity_idstring

The ID of the entity to filter logs.

entity_typestring

The type/category of the entity to filter logs.

entity_namestring

The name of the entity affected by the action.

usernamestring

The username of the user performing the action.

ipstring

The IP address of the client device that initiated the action.

event_sourcestring

The source of the event to filter logs.

next_tokenstring

Token for fetching logs of the next page.

Response

A list of audit logs matching the given filters.

idstring

Unique ID for the audit event

actionstring

Action being audited

descriptionstring

One-liner describing the audit event

timestampstring date-time

Event timestamp

workspace_usernamestring

Example response

{
  "id": "ae026c8c-3c13-45a3-9b36-5a16d42937db",
  "action": "connection_group_added_with_role",
  "description": "group added to connection",
  "context": {
    "correlation_id": "1f521917-5e07-4094-ae08-1b6254a2a6c8"
  },
  "actor": {
    "ip": "157.52.123.41",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36",
    "user_id": "b903c024ac72",
    "username": "sample_user_name"
  },
  "entity": {
    "entity_name": "Sample workspace name",
    "entity_type": "workspace_connection",
    "entity_id": "a45aaf31658b"
  },
  "timestamp": "2025-02-18T10:47:37.000000Z",
  "workspace_username": "sampleworkspaceusername"
}

Changes