View & Export the User Audit Trail

Overview

Review the list of important notes in the User Audit Trail Overview article for more information regarding the User Audit Trail.


User Account Requirements

The user account must have Administrator permission to access the User Audit Trail and Swagger.


Related Information/Setup

For details on the events captured in the audit trail, see the User Audit Trail Events & Filters article.


Navigation

  1. From any of the Resolver main screens, click the System icon in the top right-hand corner of the screen.

System Icon Location

  1. From the Administration Overview screen, select the User Audit Trail tile from the Tools section.

User Audit Trail Tile

View the User Audit Trail

  1.  From the Tools screen, select the User Management Audit Trail link from the Toolbar.

User Management Audit Trail Link

  1. Optional Functions:
    • Search Fields (1): Apply search filters to narrow down the data:
      • Time: Select a Start and End Date from the Calendar pop-up to create a date range.
      • Subject: Narrow the data by selecting a Subject (e.g., User, User Group, Role, etc.) from the drop-down list.
      • Event: Narrow the data by selecting an Event from the drop-down list.
      • Performed By: Narrow down the data by selecting a User that performed the event from the drop-down list.
    • Navigation Icons (2): Located in the top right-hand corner of the Audit Trail table.
      •  Page Number: Click a Page Number to navigate to a specific page.
      • Previous <: Click the Previous icon to navigate to the previous page in the series.
      • Next >:  Click the Next icon to navigate to the next page in the series.
    • Refresh Icon (3): Located in the top right-hand corner of the Audit Trail table.
      • Refresh: Click the Refresh icon to refresh the data.

Optional Functions

  1. Click an Event to display the Additional Details pop-up.

Additional Details Pop-up

Export the User Audit Trail

Administrators can export data from any time range; however, the API only returns the most recent 50,000 results. You can make an additional API request using the last event row's date in the .csv file as the dateEnd value to obtain any truncated data. See Step 15 in the Export the User Audit Trail section below for more details.

Note:
 Recent events will appear in the audit trail after a few minutes of processing time.

  1. From any of the Resolver main screens, click the System  icon in the top right-hand corner of the screen.

System Icon Location

  1. From the Administration Overview screen, select the Swagger Doc tile from the Tools section.

Swagger Doc Tile

  1. From the Swagger API Documentation screen, click the Audit Trail link to open the Swagger interface.

Audit Trail Link

  1. Navigate to auditTrail and click on the auditTrail link to open the API options.
  2. Click POST /audit/user/export (Export User Audit Trail Data) to expand.

POST /audit/user/export

  1. Click the Example Value textbox in the Parameters section to code the code into the Value Textbox.

Example Value

  1.  Delete the beside the dateStart attribute in the Value textbox and enter an audit trail data start date in Unix timestamp format. Repeat the process to enter an end date for the dateEnd attribute.

Swagger Value Textbox Filled Out

  1. Click the Try it out! button at the bottom of the API to run the API call.
  2. Copy the Job ID from the Response Body section.

Job ID 

  1. Scroll down to the Job link and click on it to expand it.

Job Link

  1. Click GET /object/job/{id} (Poll for status of job) to expand it.

Get/object/job/{id}

  1. Paste the Job ID from step 8 into the id field.

ID field

  1. Click the Try it out! button at the bottom of the API to run the API call.
  2. Copy the URL next to the signedURL attribute in the Response Body section.

SignedURL

  1. Open a browser and paste the URL in the address bar to begin downloading the CSV file. Up to 50k records are returned per file.

Exported User Audit Trail Data

  1. To export more than 50k records within the selected time frame:
    • Review the last row of the .csv file to confirm it contains a maximum of 50k rows.
    • Convert the date in the Date and Time column for the last row to Unix timestamp format.
    • Make a new API request using the Unix timestamp from the last row as the new dateStart value but keeping the dateEnd the same.
    • Continue the process until fewer than 50k rows are retrieved. 

Note: 
Multiple events can occur at the same time. Rows may share the same Date and Time value. If the oldest event (last row on the CSV file) occurred on the same date as other events, all these events would be repeated in the next generated CSV file.