| description | Use the Audit API to track and retrieve activity logs programmatically. |
|---|
The Audit API enables you to track and retrieve activity logs across the Marketplace Platform, so you have full visibility into key actions taken by users or systems.
Use this API to create audit records, list logged events for monitoring or compliance, and retrieve details for specific events.
Review the shared API docs before you work with audit resources.
The Audit API is built around the following core resources:
- Audit record – Represents a detailed record of an event that took place within the platform.
- Audit event types – Represents the event types used within the platform.
The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.
See the following sections to determine which roles are authorized to perform specific operations within each collection:
| Operation | Method | Description | Access |
|---|---|---|---|
| Create audit record | POST | Creates an audit record. | vendor, client, ops |
| List audit records | GET | Retrieves the audit records collection. | vendor, client, ops |
| Get audit record | GET | Retrieves an audit record by ID. | vendor, ops |
| Operation | Method | Description | Access |
|---|---|---|---|
| List audit event types | GET | Retrieves the list of all known audit event types. | vendor, client, ops |