Audit Logs captured by Whatfix

Updated On 19 Jun 2024
2 Minutes To Read

Print
Share
Dark

Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

An Audit log (or audit trail) is a record of events and changes. The Whatfix Audit logs capture events that show "who" did "what" on the Whatfix Dashboard and "when". These logs provide insights into activities that were performed by users in the past.

Here's what a sample Audit Log looks like:

Whatfix captures certain logs that enable the audit of specific actions that users perform on Whatfix. For example, track who was the last user to export content from the Whatfix dashboard. The following are the actions that are captured in the Audit logs:

Note:

Along with the Data captured in the Logs, these actions also capture common information described in the table below.

Category	Action	Data captured in Logs
Advanced Customization	Update the Advanced Customization code	User Time
Analytics	Export Analytics Summary report Export Task List report	User Time
	Enable Google Analytics integration Disable Google Analytics integration	User Time
	Enable Whatfix Analytics integration Disable Whatfix Analytics integration	User Time
API	Update	API token of the user
	API Method (End User)	Any API Method (PUT, DEL)
	API Method (End User Schema)	Any API Method (PUT, DEL)
Beacon refresh	Update	Segment Type, Segment ID
Content	Creating new content Updating a content Deleting a content	Content Type Content ID
Content Share	Export	Content Type Content ID
Dashboard	Log in Log out	User Time
Deployment	Deploy	Extension/Export/Direct Chrome/IE/Firefox/Edge
Integration	Renew API Token	API token of the User Time
	When End User PUT APIs are called When End User DELETE APIs are called	User Time
	When End User Schema PUT APIs are called When End User Schema DELETE APIs are called	User Time
Knowledge Base	Create a new Knowledge Base Update a Knowledge Base Delete a Knowledge Base	Knowledge Base URL Knowledge Base name
Segments	Create a new widget segment Update a widget segment Delete a widget segment	Segment Type Segment ID
Tags	Create a tag Update a tag Delete a tag	Tag Type Tag ID
Translation	Export language file Import language file	Language code Language File
Translation	When content is translated in the UI and saved	Content Type Content ID
Widget Configuration	Update	User Time
xAPI/SCORM	Exporting content	Content ID Tag ID, if any
Video Channel	Authorize a video channel for the first time Unauthorize a video channel Reauthorize a video channel	User Time

The following data is common information captured for all actions.

Data Captured

Description

Ent Id

The enterprise Id of the client logged in to the dashboard

User Id

The customer Id of the user who logged in to the dashboard

Timestamp

The time at which the event was captured

Source IP

Source of the request (client-side)

Host IP

Server that catered to the request (server-side)

Action details (ad1, ad2,...)

Provides more information on where the change has occurred. For example, if a change is made to a Link in a Flow, then ad1 = flow and ad2 = link.

your title goes here

To anonymize the Source IP, copy and paste the following code in the Advanced Customization section:

_wfx_settings.analytics_properties.anonymizeIp = true;

Download Audit Logs from the Whatfix dashboard

Whatfix enables you to download Audit Logs from the dashboard directly to view the activities performed.

Your title goes here

Only an Account Manager can perform the following task. For more information on the available user roles and permissions, see Whatfix User Roles.

Use the following steps to download the Audit Logs:

On the Whatfix Guidance dashboard, click Settings.

Click Team audit logs.
In the pop-up, Select a date range for which you want to download the Audit Logs.
Your title goes here
The following date configurations are available:
- Last 90 Days
- Last 30 Days
- Custom Date (Select a date range that covers up to a year)
Click Download Audit Logs.
Your title goes here
The Audit Log is downloaded as a .csv file.
Your title goes here
To download Audit Logs using Developer APIs, see Whatfix API Reference Beta.