Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Audit Logs

Prev Next

Unqork logs administrative and configuration activity across the platform. Audit logs capture who performed an action, what changed, and whether it succeeded—providing a traceable record for compliance, troubleshooting, and security review.

Audit logs are not available through the Unqork IDE. Access is through the API Reference using the GET /logs/audit-logs endpoint. Designer Administrator access is required.

Logged Events

Unqork tracks activity across the following categories:

  • Modules: Actions include adding, deleting, and saving modules, as well as changes to module settings, permissions, translation settings, workflow settings, and transform operations.
  • Applications and Workspaces: Actions include adding, deleting, modifying, promoting, exporting, moving, and previewing applications, as well as changes to workspace configuration and workspace membership.
  • Creator and Express Users: Actions include adding, modifying, deleting, and revoking Creator accounts, role assignments, and Express user records.
  • Email Templates: Actions include modifications to email template content and subject lines.
  • Data Access: Data read and write operations are tracked separately as data access events.

Event Structure

Each audit log entry includes the following fields:

Field Description
userId The ID of the Creator who performed the action.
eventAction The specific action performed.
source The origin of the action. Always DesignerApi for platform events.
outcome Whether the action succeeded or failed. Failed outcomes include a reason and details.

For modifications, the log also captures the prior state of the resource, allowing before-and-after comparison.

Querying Audit Logs

endpoint: GET /logs/audit-logs

Access: Designer Administrator only.

Query Parameters

Parameter Required Description
startDatetime Yes The start of the query window in ISO 8601 format. Seconds and milliseconds must be 0.
endDatetime Yes The end of the query window in ISO 8601 format. Seconds and milliseconds must be 0.
unzip No When true, returns decompressed log content. Defaults to false.
schemaVersion No The event schema version to use. Defaults to 1.0.

Important: The query window must not exceed one hour, and start time must be before end time.

Example request:

GET /logs/audit-logs?startDatetime=2026-04-13T10:00:00.000Z&endDatetime=2026-04-13T11:00:00.000Z

Both startDatetime and endDatetime must be set to the exact minute—seconds and milliseconds must be 0. The window in this example is exactly one hour, which is the maximum allowed.

Response

{
  "logLocations": ["string"]
}

The response returns an array of signed URLs pointing to the log files for the requested time window. Each URL expires 15 minutes after the response is returned. Log files are stored in gzip (.gz) format—set unzip: true to receive decompressed content.


Changelog

Date Change
Initial publication.