Audit Logs

List audit logs with optional filtering

getaudit/logs

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/audit/logs
  • Auth: api_key (a scheme the document does not define)

Query parameters

operation_typestring

Filter logs by operation type (omit for all)

user_idinteger

Filter logs by user ID (omit for all users)

fromstring date-time

Start timestamp, ISO 8601 (e.g. "2024-01-15T14:30:00Z")

tostring date-time

End timestamp, ISO 8601 (e.g. "2024-01-15T14:30:00Z")

limitinteger

Maximum number of logs to return

offsetinteger

Number of logs to skip

Response

List of audit logs

audit_dateinteger required

When the action occurred

dataunknown
idinteger required

Unique identifier for the audit log entry

operation_typestring required

The type of action that was performed

user_idinteger nullable

The user who performed the action (null when that account has since been deleted; data retains the original actor context)

Example response

[
  {
    "audit_date": 11932193,
    "ip_address": {
      "city": "San Francisco",
      "country": "US",
      "ip": "192.168.1.1",
      "latitude": 37.7749,
      "longitude": 122.4194
    },
    "operation_type": "USER_LOGIN",
    "user": {
      "email": "john.doe@example.com",
      "name": "John Doe"
    }
  }
]

Changes

No recorded changes to this operation across all 53 revisions of this API.