Getting started with the Audit Query API

Adobe Experience Platform allows you to audit user activity for various services and capabilities in the form of audit events logs. Each action recorded in a log contains metadata that indicates the action type, date and time, the email ID of the user who performed the action, and additional attributes relevant to the action type.

The Audit Query API allows you to audit user activity for various services and capabilities in the form of audit event logs. This document provides an introduction to the core concepts you need to know before attempting to make calls to the Audit Query API.

Prerequisites

In order to manage audit events, you must have the View User Activity Log access control permission granted (found under the Data Governance category). To learn how to manage individual permissions for Platform features, please refer to the access control documentation.

Reading sample API calls

This guide provides example API calls to demonstrate how to format your requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in the documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Gather values for required headers

This guide requires you to have completed the authentication tutorial in order to successfully make calls to Platform APIs. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in. For more information on sandboxes in Platform, see the sandbox overview documentation.

All requests that contain a payload (POST, PUT, and PATCH) require an additional header:

Next steps

To begin making calls using the Audit Query API, please refer to the events endpoint guide and the export endpoint guide.