Get audit logs
Get a comprehensive audit trail of all operations performed in your Metronome account, whether initiated through the API, web interface, or automated processes. This endpoint provides detailed logs of who did what and when, enabling compliance reporting, security monitoring, and operational troubleshooting across all interaction channels.
Use this endpoint to:
- Monitor all account activity for security and compliance purposes
- Track configuration changes regardless of source (API, UI, or system)
- Investigate issues by reviewing historical operations
Key response fields:
An array of AuditLog objects containing:
- id: Unique identifier for the audit log entry
- timestamp: When the action occurred (RFC 3339 format)
- actor: Information about who performed the action
- request: Details including request ID, IP address, and user agent
resource_type: The type of resource affected (e.g., customer, contract, invoice)resource_id: The specific resource identifieraction: The operation performednext_page: Cursor for continuous log retrieval
Usage guidelines:
- Continuous retrieval: The next_page token enables uninterrupted log streaming—save it between requests to ensure no logs are missed
- Empty responses: An empty data array means no new logs yet; continue polling with the same next_page token
- Date filtering:
starting_on: Earliest logs to return (inclusive)ending_before: Latest logs to return (exclusive)- Cannot be used with
next_page
- Resource filtering: Must specify both
resource_typeandresource_idtogether - Sort order: Default is
date_asc; usedate_descfor newest first
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Max number of results that should be returned
1 <= x <= 100Cursor that indicates where the next page of results should start.
RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'next_page'.
RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.
Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
date_asc, date_desc Optional parameter that can be used to filter which audit logs are returned. If you specify resource_id, you must also specify resource_type.
Optional parameter that can be used to filter which audit logs are returned. If you specify resource_type, you must also specify resource_id.
Response
Success
The next_page parameter is always returned to support ongoing log retrieval. It enables continuous querying, even when some requests return no new data. Save the next_page token from each response and use it for future requests to ensure no logs are missed. This setup is ideal for regular updates via automated processes, like cron jobs, to fetch logs continuously as they become available. When you receive an empty data array, it indicates a temporary absence of new logs, but subsequent requests might return new data.