Export a list of audit events

Last update: 2024-11-13
  • Topics:
  • Audits
    View more on this topic
  • API
    View more on this topic
  • Created for:
  • Developer

You can retrieve events data by making a GET request to the /audit/export endpoint, specifying the events you wish to retrieve in the payload.

API format

GET /audit/export
Parameter Description
timestamp When filtering by timestamp, it is best practice to use a range using > and < operators rather than an exact value.
Example: ?property=timestamp<2020-02-08T02:46:48.610862Z&property=timestamp>2020-01-01T02:46:48.610862Z.
status The status of the action. A status can be any of the following:
  • Allow
  • Deny
  • Failure
  • Success

    • Example: ?property=status==Deny.
    action The type of action that was recorded for the event. An action can be any of the following:
    • Add
    • Create
    • Dataset activate
    • Dataset remove
    • Delete
    • Disable for profile
    • Enable
    • Enable for profile
    • Profile activate
    • Profile remove
    • Remove
    • Reset
    • Segment Activate
    • Segment remove
    • Update
    Example: ?property=action==Create.
    user The user who performed the event.
    assetType The type of Platform resource that the action was performed on.
    Example: ?property=assetType==<an asset type>.

    Request

    curl -X POST \
  https://platform.adobe.io/data/foundation/audit/events
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'x-request-id: {TRACING_ID}' \

    Response

    The results are generated into a CSV file for export. A successful response returns HTTP 307 with no response body. A link to the export file is provided in the Location response header.

    Previous page
    Next page

    On this page