Before you begin: This article is written for users who are familiar with the TapClicks platform and are interested in using Audit Logs in their instance. For more information on the TapClicks Platform, please refer to our knowledge base.
Which areas of the platform have an Audit Log?
What are Audit Logs?
Audit Logs keep track of all user activities performed within your account, including creations, edits/updates, deletions, and other actions. Audit Logs are only visible in the navigation by Super Admins with a predefined role. (This feature is not available in the Classic Experience of TapClicks.)
Audit logs help you answer "Who did what, where, and when?” Some key benefits of using an audit log include:
- Visibility: Audit Logs provide full visibility into account activities, ensuring transparency and accountability.
- Filtering Options: You can filter the logs based on various criteria, such as date range, user, or module, to quickly find the information you need.
- Export Functionality: Audit Logs can be exported for further analysis or record-keeping purposes.
Which areas of the platform have an Audit Log?
Location | Feature Coverage |
Reports |
|
Data |
|
Admin |
|
Security |
|
Understanding Audit Logs
Role-Based Access Control
Audit Logs are only accessible to users with the Super Admin User Type. As a Super Admin, you can control which Super Admins have permission to view the audit logs via the Roles page, as demonstrated below. Due to their nature as historical records, Audit Logs are not editable, meaning no users have edit access.
Accessing and Interpreting Audit Logs
Once you've accessed the Audit Logs, you'll see a detailed list of actions performed within your account. Each entry includes information such as the Scope, Category, Sub-Category, Action, Action Details, Changed Object, Date of Change, Performed By, Current Role, From File Upload, and additional Details.
You can easily navigate to the area of change by clicking on the Changed Object link in the Audit Logs table.
- Scope: Refers to the broad areas within the system where actions are being logged. These could include administrative actions, data-related activities, reporting activities, and more.
- Category: Specifies the specific modules or application areas within the system where actions are being performed. This could encompass modules such as Business Units, Roles, Users, Custom Translations, and other relevant components of the system where activities are being tracked.
- Sub-Category: Represents more granular divisions within each category, providing additional context or specificity about the type of action being logged within a particular module.
- Action: Describes the specific operation or activity performed within the system. It could include actions such as creation, modification, deletion, or other relevant operations.
- Action Details: Provides additional information about the action performed, offering a more comprehensive understanding of what occurred. Example: For the ‘Perform’ action, Action Details would include Login Succeeded, Impersonated, File Downloaded, etc.
- Changed Object: Refers to the entity or object within the system affected by the action. It identifies what was altered or impacted as a result of the action taken. For example, if a user's role was modified, the changed object would be that specific user's role.
- Date of Change: Indicates the date and time when the action was performed. Audit logs are displayed based on the time zone selected at the User level.
- Performed By: Indicates the user or entity responsible for executing the action. It helps attribute actions to specific individuals or roles within the organization, promoting accountability.
- Current Role: Specifies the role of the user who performed the action at the time of the activity.
- From File Upload: Indicates whether the action was initiated through a file upload process. "Yes" denotes that the action was carried out via a file upload, while an empty field indicates that the action was performed manually.
- Details: Includes information about the object's state before and after the action was executed. The red color indicates the state of the affected object before the action was performed, and the green color denotes the state of the affected object after the action was executed. For example, if a user's role was updated from ‘Account Manager’ to ‘Marketing Champ,’ the "Details" section displays ‘Account Manager’ in red and ‘Marketing Champ’ in green.
Audit Logs Expiry
In Admin and Platform Settings, a Super Admin can select how long audit logs are kept before deletion.
- 90 days: Audit logs will be retained for 90 days before being automatically deleted.
- 180 days: Audit logs will be retained for 180 days before being automatically deleted.
- Never: Audit logs will be retained indefinitely
Accessing Audit Logs
There are three ways to access Audit Logs: in Admin, at the module level, or the feature level if you would like to review a log while you're working with a certain tool.
Centralized Audit Logs
1] In the left navigation menu, click Admin then click Audit Logs.
2] The Audit Logs overview will open. Here you can view the who, where, and when for all actions taken on your TapClicks instance.
Module Level Logs
1] Navigate to any of the supported features from the table above.
2] Click on the Logs icon in the list view of the page.
Feature Level Logs - Dashboards
1] In the left navigation, click Reports and Dashboards.
2] Change to list view (if you are not in list view already) by clicking the list view icon on the right.
3] Click the Audit Logs icon on the right side of the screen.
- You can also see the logs at the widget level just by clicking on the more options menu ( ⋮ ellipses icon) and Audit Logs.
Feature Level Logs - Users
1] In the left navigation, click Admin and Users.
2] Click the Audit Logs icon on the right side of a user's name to see all changes a specific user has made.
Feature Level Logs - Clients
1] In the left navigation, click Admin and Clients.
2] Click the Audit Logs icon on the right side of a user's name to see all changes a specific user has made.
Feature Level Logs - Smart Connectors
1] In the left navigation, click Data and Smart Connectors.
2] Click the Show More icon (i.e. vertical three dots) on the right side of a Smart Connector.
3] From the available options, select View Audit Logs for this record.
How to Download Audit Logs
1] Navigate to the Audit Logs in the section of the platform you are interested in.
2] At the top of the Audit Logs page, click on the download icon (📥). This will download your logs as a CSV file, based on any date filters you've applied.