GET /interaction/v1/interactions/key:{key}/audit/{action}

Retrieves an audit log for one or all versions of a journey by specifying its external key. You can specify different actions to see history related to the creation, modification, activation, deactivation, stopping, and deletion of a journey.

Specify these parameters in the URL.

Name	Type	Description
action	String	Required. The actions to include in the audit log. Specify all to return all actions. Possible values: all create modify publish unpublish delete
key	String	Required. The external key of the journey to retrieve audit logs for. Specify the key in this format /interactions/key:{key}/audit/{action}.

Use these optional query parameters to further refine the results.

Name	Type	Description
$page	Integer	The page number of results to return. The default value is 1.
$pageSize	Integer	The number of items to return in a page of results. The default value is 50. The minimum value is 1 and the maximum is 50. This value is only honored if the query string also specifies the $page parameter.
mostRecentVersionOnly	Boolean	If true, the response includes an audit log for the most recent version of the journey. Don't specify this parameter if you specify the versionNumber parameter or if mostRecentVersionOrRunningOnly is true.
mostRecentVersionOrRunningOnly	Boolean	If true, the response includes an audit log for the running version of the journey and the next draft version, if one exists. Don't specify this parameter if you specify the versionNumber parameter or if mostRecentVersionOnly is true.
status	String	A journey status value to filter the results by. Possible values are: Deleted Draft None Paused Pausing Published Resuming ScheduledToPublish ScheduledToSend ScheduledToStop Sent Stopped Unpublished
versionNumber	Integer	The version number of the journey to retrieve audit logs for. If you don't specify this parameter, the response includes audit logs for all versions of the journey.

To retrieve audit logs, determine which type of action you want to view. This example returns all actions for version 2 of the specified journey.

The response is a log that includes these elements:

• The current page number of results.
• The number of items returned in each page of results.
• The total number of items that meet the request parameters.
• An Items array. The array includes an object for each action. All objects in the array include these elements:
  • The ID, key, name, and description of the journey
  • The original definition ID
  • The date and time when the action occurred
  • The name and ID of the user who performed the action

This example shows an Items array that contains Create, Modify, Publish, and Stop actions.

• Get Journey Audit Logs by ID