Auditing

Audit Trail

get

/audit_trail

This endpoint returns a list of audit trail events for the authenticated user's organization.

To obtain data from this endpoint, the authenticated user must be an organization admin and the data returned is equivalent to the what an Organization admin would be able to get from the Soda Cloud UI under "Organization Settings > Audit Trail".

Usage

Use this endpoint to capture audit trail events for security and usage monitoring purposes.

Returns

An object of type AuditTrailResult containing an array of AuditTrailData.

Find details about the response objects in the Schemas section or by unfurling the response details.

Authorizations

AuthorizationstringRequired

Query parameters

from_datetimestring · date-timeOptionalDefault: 2023-10-09T09:18:16.610035

to_datetimestring · date-timeOptionalDefault: 2023-11-09T09:18:16.610057

Responses

200

Successful Response

application/json

Array of AuditTrailData.

resourcestringOptionalDefault: audit_trail

202

Successful request but no data was returned

application/json

422

Validation Error

application/json

get/audit_trail

GET /v1/audit_trail HTTP/1.1
Host: reporting.cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "data": [
    {
      "correlation_id": "text",
      "eventTime": "2026-01-01T00:00:00.000Z",
      "ipAddress": "text",
      "email": "text",
      "apiKey": "text",
      "comment": "text",
      "hash": "text"
    }
  ],
  "resource": "audit_trail"
}