1. Audit Logs
Audit Logs Overview
Audit logs provide a comprehensive record of all activities and events within your Circularo environment. They are essential for security monitoring, compliance reporting, troubleshooting, and maintaining accountability across your organization.
Understanding Audit Logs
Circularo's audit logging system captures detailed information about every significant action:
User Activities: Logins, password changes, and other authentication events
Document Operations: Creation, reading, editing, signing, and deletion of documents
Administrative Actions: User management, permission changes, and system configuration updates
Sharing Events: Document sharing, access grants, and collaboration activities
Key Audit Log Components
Each audit log entry contains essential information to help you understand what happened, who was involved, and when it occurred:
Actor Information: Who performed the action (user ID)
Activity Type: What action was performed (created, read, signed, deleted, etc.)
Target Details: What object was affected (document, user, group, etc.)
Timestamp: When the action occurred
Contextual Data: Additional details specific to the action type
Business Benefits
Implementing proper audit log monitoring provides significant advantages:
Security Monitoring: Detect suspicious activities and potential security breaches
Compliance Requirements: Meet regulatory obligations for record-keeping and auditing
Accountability: Track user actions and maintain clear responsibility trails
Troubleshooting: Investigate issues by reviewing the sequence of events
Usage Analytics: Understand system usage patterns and user behavior
Audit logs contain sensitive information about user activities and document operations. Access to audit logs should be restricted to authorized personnel only.
Working with Audit Logs
Circularo provides powerful APIs for retrieving and analyzing audit logs:
Searching: Find specific events using various criteria (user, action type, time range, etc.)
Scrolling: Efficiently process large volumes of logs for analysis or archiving
Filtering: Focus on relevant events by applying multiple filter conditions
Audit logs are immutable records that cannot be modified or deleted, ensuring the integrity of your system's activity history.
Getting Started
The scenarios in this section demonstrate the complete range of audit log capabilities:
Begin with searching audit logs to understand how to find specific events
Learn how to combine different filter types for precise event targeting
Explore scrolling techniques for efficiently processing large volumes of logs
Understand best practices for audit log retention and analysis
When working with large volumes of audit data, use the scrolling API instead of pagination to ensure consistent and efficient data retrieval.