Stirling PDF icon

Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

Audit → Get Audit Data

AI-generated

Summary

Retrieve audit log entries with filters for event type, principal (username), date range, and pagination parameters.

Inputs

  • Page — Page number for pagination; defaults to 0.
  • Size — Number of audit records per page; defaults to 30.
  • Type — Filter by specific audit event type such as USER_LOGIN, USER_LOGOUT, etc.; defaults to USER_LOGIN.
  • Principal — Filter by the username (principal) associated with audit events; defaults to 'admin'.
  • Start Date — Start date of the audit data export range in YYYY-MM-DD format; defaults to 2025-01-01.
  • End Date — End date of the audit data export range in YYYY-MM-DD format; defaults to 2025-12-31.

Output shape

a JSON object containing a paginated list of audit log records filtered according to the provided parameters.

Pagination is controlled using 'Page' and 'Size' parameters. Filtering by 'Type', 'Principal', 'Start Date', and 'End Date' narrows results accordingly. The output structure aligns with the StirlingPDF API's audit data response format.

Links

Discussion