Audit API

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.

With this API, you can create new audit records programmatically, retrieve a list of logged events for monitoring or compliance purposes, and get detailed information about specific events.

Try APIDownload API

Core Concepts

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 type - Represents the event that occurred within the platform.

Collections

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.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Audit Records

Capability	Client	Vendor	Operations
List audit records	✅	✅	✅
Get audit record	✅	✅	✅
Create audit record	❌	✅	✅

Audit Event Type

Capability	Client	Vendor	Operations
List audit event types	✅	✅	✅