Skip to content

Audit Logs

Audit logs track important actions taken in your organization through the API or dashboard. Each log entry contains information about the action, when it occurred, and relevant metadata.

List Audit Log Entries

GET /audit_logs

Returns up to 100 audit log entries, ordered by most recent first.

Query parameters:

  • before: ID of the audit log entry to start listing before (non-inclusive), used for pagination. If not provided, starts from the most recent entry. IDs are prefixed KSUIDs, so they are sorted in time.

Response

200 application/json:

interface ListAuditLogEntriesResponse {
AuditLogEntries: Array<{
OrgID: string
ID: string
ActionName: string
Data: Record<string, any> // Object based on the event // JSON string containing action-specific data
CreatedAt: string // ISO 8601 (RFC3339)
}>
}

Get Audit Log Entry

GET /audit_logs/:entryID

Retrieve a specific audit log entry by ID.

Response

200 application/json:

interface AuditLogEntry {
OrgID: string
ID: string
ActionName: string
Data: Record<string, any> // Object based on the event
CreatedAt: string // ISO 8601 (RFC3339)
UpdatedAt: string // ISO 8601 (RFC3339)
}

404: Entry not found

Audit Log Entries

Audit log entries typically will include in their data:

  • api_key_id: The ID of the API key used to perform the action
  • api_key_name: The name of the API key used to perform the action
  • user_id: The ID of the user who performed the action
  • user_email: The email of the user who performed the action

Retention

Audit logs are retained indefinitely and cannot be deleted. They do not contain PII or any job data other than campaign, org, and job ID.