Overview
Use the Audit Log API to:- Monitor Activity: Track who accessed what and when
- Investigate Incidents: Reconstruct user behavior in a specific time window
- Support Compliance Reviews: Prove access boundaries for sensitive projects or client data
Endpoints
Search Audit Logs
Get Latest Audit Log Entries
Use Cases
Use Case 1: Compliance Monitoring and Audit Trail Capture
Challenge: Firms must track who accessed or exported sensitive data to maintain compliance with data protection obligations. Solution: Use the Audit Log API to log document downloads, project views, or permission changes.Use Case 2: Incident Response and User Investigations
Challenge: In the event of suspected misuse, security teams need to reconstruct the timeline of a user’s actions. Solution: Use/logs/audit/search
with filters for email
, action
, and timestamp
to narrow down relevant records.
Use Case 3: Proactive Access Monitoring
Challenge: Clients may request proof that their documents were never accessed outside of expected workflows. Solution: Periodically extract and store audit logs for high-sensitivity projects.Best Practices
- Use
start_time
andend_time
: Narrow your queries to relevant time ranges using epoch timestamps - Filter by action type: Filter for
document.download
,login
,project.access
, etc. for more focused results - Monitor privileged activity: Identify unusual behavior by users with elevated permissions
- Log downstream storage: Store copies of logs in your own SIEM or audit repository
- Use
/latest
for freshness: Poll the/latest
endpoint in high-alert scenarios to capture real-time activity
Error Handling
Status Code | Description | Example Error Message |
---|---|---|
200 | Success | N/A |
400 | Bad Request – Invalid query input | { "error": "Missing required filters" } |
401 | Unauthorized – Invalid API key | { "error": "Unauthorized" } |
429 | Too Many Requests – Rate limit exceeded | { "error": "Rate limit exceeded" } |
500 | Internal Server Error | { "error": "Unexpected server error" } |
Need help getting started? Contact your Harvey Customer Success Manager for more information.