The Audit Trail feature plays a crucial role in ensuring transparency and accountability for all changes made to the data within your system. It functions as a detailed log that tracks modifications and updates, providing you with a comprehensive overview of the activities that have taken place. This article will guide you through the process of accessing and effectively using the Audit Trail feature.
TABLE OF CONTENTS
- Accessing the Audit Trail
- Selecting an Entity
- Date Range and Archived Records
- Filtering by User or System
Accessing the Audit Trail
To access the Audit Trail, navigate to Administration → Audit / Logs → Audit Trail.
Selecting an Entity
You will need to select a specific entity to return any results in the Audit Trail.
Choose the Entity type from the available options.
The search results will show all changes related to that entity type. Depending on the entity type, you may have additional filters available.
For a comprehensive breakdown of each entity type, refer to this article.
Date Range and Archived Records
You can specify a date range to retrieve records within a specific timeframe. However, you can only view records from the past 180 days on your system.
If you need records beyond this period, check the Include archived checkbox.
Once you've selected your desired options, click the Search button.
This will present you with a table containing the audit records based on your selected settings.
The table can be sorted by the Date / Action column if desired.
If the Include archived checkbox is checked when you click on the Search button, records that are older than 180 days will be included according to the date range selected.
You can also export the results shown in the Audit Trail as a CSV report. Click on the Export button to start the process of creating the report.
A CSV document containing the Audit Trail results will be generated. This report will only include the records shown from your search results.
Filtering by User or System
The Audit Trail allows you to filter the results based on the changes made by specific users.
In the User field, enter the User ID of the user with the activity you want to see. You will see some options for User IDs to choose from, select the desired User ID from the list.
If you have API Access enabled and an active API key configured in your system, you can filter the results by specific systems using that API key.
In the System section, type the name of the API key. You will see some options for API key names in your system, select the desired API key name from the list.
