Export and View Content Performance Data in Diagnostics

Note:
Whatfix Diagnostics is available across all Delivery modes.
If Whatfix Studio is available on the browser, open Diagnostics directly from Studio.
If Whatfix Studio is not available on the browser, Diagnostics can be opened as a standalone entity using Option + Shift + D (on macOS) or Alt + Shift + D (on Windows). For more information, see Troubleshoot content when Whatfix Studio is not available.

Whatfix Diagnostics enables you to export your diagnostics logs together in one place and download them all as a CSV report that shows the following details for every content item on the page:

whether Whatfix evaluated and displayed it
how its Visibility Rules and Element Precision rules evaluated
how long Whatfix took to evaluate it, find its element, and display it
what to fix when something fails or runs slow

For example, before you move a large set of content to the Production stage, you can identify the content that takes the longest to display and fix it. You can then share the report with your IT or security team as evidence for their approval.

Exporting diagnostics logs from Diagnostics

Note:
Diagnostics exports the logs for the page you open. Go to the page where your content appears before you start.
Exporting the report doesn't affect how your application performs for your users.

Download Diagnostics Logs

Use the following steps to download the diagnostics logs:

Go to the page where you want to troubleshoot your content and launch Whatfix Studio.
Click the Diagnostics icon.
Click Preview Mode.
Note:
If the content you want to preview is in the Draft stage, then select the Include Draft content and widgets. checkbox.

If you enable Preview Mode from the content creation page, you must manually refresh the page to activate Preview Mode.
Click Enter and wait for the page to refresh automatically.

Once the page opens, Diagnostics helps you view all the relevant content and widgets for that page.
Info:
Consider that you have created multiple pieces of content across your application. When testing this content on different pages, you would expect it to appear on the correct page or section.
To help you identify the content that is applicable to appear on a specific page, Diagnostics categorizes content into two sections:
- On this page: Lists content and widgets that are configured to appear on the current page. This includes content that has a valid URL or page tag condition that matches the current page.
- Not on this page: Lists contents and widgets that don't belong on the current page. This implies the visibility rules, URL conditions, or page tags that are not applicable on the current page.
The sections act as a built-in filter, helping you identify missing content and troubleshoot issues more efficiently.

Click the Download diagnostics logs icon.
Click Download.
Open the two downloaded CSV files in a spreadsheet tool.
Info:
You don't need a Whatfix account to access the CSV files.

Files in the Diagnostics Report

Each download contains two CSV files. The content information file provides the details of each content item. The meta data file summarizes the whole session, including the browser details and every threshold breach. A threshold is the recommended maximum evaluation time for content, a component, or a rule. The values in both files match what Diagnostics displays.

The two CSV files have the following file names and contents:

File	File name starts with	What it contains
Content information	`content-information-`	Contains one row for each content item or step, along with its evaluation status, configured rules, time taken to evaluate and display it, and recommended actions.
Meta data	`meta-data-`	Contains a summary of the Diagnostics session, including browser and device details and any threshold breaches that occurred.

For any performance or content-related issue, attach both files to your support ticket. The two files give Whatfix Support the details required to investigate the issue, often without a call.

Note:
The meta data file includes browser and device details along with your Enterprise ID, so check your organization's policies before you share the files outside your team.
The report measures how long Whatfix takes to evaluate your content, not the overall performance of your application.
Thresholds are Whatfix's recommended benchmarks, so treat a breach as an indicator of a performance issue rather than proof of one.
Whatfix displays timings only where it can measure them reliably, so some processing time cannot be attributed to a specific rule or component.
For very large applications, a single export might not include all the data.

Content Information File

Each row of the content information file represents one content item, or one step of multi-step content, on the page.

Expand the following accordions for more details:

Content details

The content details columns identify each content item by its category, ID, name and type, and show its step number, the collection or flow it belongs to, and its stage.

Column	Description
Content Category	The kind of item: Content, Widget, Tag, or Events.
Content ID	The unique ID of the content item.
Content Name	The name of the content or step.
Content Type	The content type, such as Beacon, Smart Tip, Pop-up, Page Tag, or Launcher collection.
Step Number	The position of the step in multi-step content.
Collection Name / Flow Name	The collection or Flow that the item belongs to.
Stage (Draft, Ready, or Production)	The current stage of the content.

Evaluation and display status

The evaluation and display status columns show whether each content item is configured for the current page, whether Whatfix evaluated it, and whether it was displayed.

Column	Description
Is it "on this page"?	Whether the content is configured for the current page.
Is it Evaluated on the page	Indicates whether Whatfix evaluated the content: Yes: Whatfix evaluated the content. No: Whatfix did not evaluate the content. Yes (MISS): Whatfix evaluated the content but couldn't find its associated element, so the content did not appear. Check the recommended action for that row.
Is it Displayed on the page	Indicates whether the content appeared on the page: Yes: The content appeared on the page. No: The content did not appear on the page.

Column

Description

Is it "on this page"?

Whether the content is configured for the current page.

Is it Evaluated on the page

Indicates whether Whatfix evaluated the content:

Yes: Whatfix evaluated the content.
No: Whatfix did not evaluate the content.
Yes (MISS): Whatfix evaluated the content but couldn't find its associated element, so the content did not appear. Check the recommended action for that row.

Is it Displayed on the page

Indicates whether the content appeared on the page:

Yes: The content appeared on the page.
No: The content did not appear on the page.

Rules and evaluation results

The rules and evaluation results columns list the Visibility Rules and Element Precision Rules configured on each content item, show how each rule evaluated, and name the method the Finder used to locate the target element.

Column	Description
Visibility Rules/ display rules	The Visibility Rules or display rules configured on the item.
Evaluation Status of Visibility Rules/ display rules	Indicates the overall result of the Visibility Rules evaluation: True: The Visibility Rules evaluated to true. False: The Visibility Rules evaluated to false.
Element Precision Rules/ display rules	The Element Precision rules configured on the item, with the result and time taken for each condition.
Evaluation Status of Element Precision Rules/ display rules	The overall result, with the total time taken and the conditions that evaluated to false.
Finder Filter	The method the Finder used to locate the target element, such as `defaultPivot`, `innerText`, `element_selector`, or `depth`. The Finder is the part of Whatfix that locates the element your content is attached to.

Timings

The timing columns show how long Whatfix takes to evaluate, locate, and display each content item, measured in milliseconds. Whatfix compares these values against the recommended maximum time (threshold) for each content item, component, or rule.

Column	Description
Time taken to find the step (ms)	The time Whatfix took to find the element for the step. The column header shows the threshold, such as Threshold set = 100 ms. For example, if Whatfix takes 150 ms to find an element, it exceeds the threshold by 50 ms. This may indicate that Whatfix takes longer than recommended to locate the element.
Time taken by Visibility Rules (ms)	The time the Visibility Rules took to evaluate. For example, a high evaluation time may indicate that Whatfix takes longer to determine whether the content should appear on the page.
Overall time taken to display (ms)	The total time until the content appeared. For example, a high value indicates that the content took longer to appear on the page, which may affect how quickly users see it.

Recommended actions

The recommended actions columns explain the issue with each content item, what to do to fix it, and every threshold the item breached.

Column	Description
Diagnostics recommended Action Item	A plain-language explanation in two parts: What is the issue? and What should you do?
System Health Summary	Every threshold the content item breached, with the time taken, the threshold, and the difference. For example, `step_find_time`: 150ms (threshold: 100ms, breach: +50ms) indicates that Whatfix took 150 ms to find the element associated with the content item, exceeding the recommended maximum time of 100 ms by 50 ms.

For more information, see Identify and Fix Visibility Rule Failures using Diagnostics.

Meta Data File

The meta data file contains three sections that summarize the Diagnostics session, timing breaches, and frequency events. Each section starts with a title row.

Expand the following accordions for more details:

System Level Information

The System Level Information section summarizes the session and the environment it ran in.

Field	Description
Total Content Items	The number of content items Whatfix checked.
Total Timing Violations	The number of times a timing threshold was breached.
Total Frequency Events	The number of activity frequency events Whatfix recorded.
Monitoring Start Time and Exported At	The time monitoring started and the time you downloaded the report.
Enterprise ID and Instance Name	The Whatfix account that the report belongs to.
Browser and device details	The browser, device, operating system, screen, and network details of the session, such as browser version, CPU cores, device memory, viewport size, and connection type. A slow connection or a low-memory device can increase the time Whatfix takes to evaluate and display content.

System health timing summary

The System health timing summary section lists every threshold breach in the session, one row per breach. Sort the rows by Breach Amount (ms) to find the largest breaches first.

Column	Description
Entity ID, Entity Type, Entity Name	The item that breached the threshold. Entity Type is a value such as segment, collection, or tag.
Content Type, Step Number, Step Title	The content and step involved, where applicable.
Violation Category	The part that ran slow: `step_find_time` for finding the element, `display_rules`, `element_precision`, or `avr` for the Visibility Rules of segments and collections.
Condition Index	The condition in the rule that ran slow.
Time Taken (ms), Threshold (ms), Breach Amount (ms)	The time taken, the threshold, and the amount by which the time exceeded the threshold.
Visibility ID, Rule Type, AVR Category	The Visibility Rule and rule type involved.
Rule Metadata	The configuration of the rule, such as its operator and value.
Timestamp	The time of the breach.

System health frequency summary

The System health frequency summary section lists the background Whatfix activities in the session, with the following details for each activity:

how often the activity ran, in the Count column
the threshold for the activity
whether the activity breached its threshold, in the Is Violation column
how long the activity took

Whatfix Support uses this section to investigate issues.

Pre-Production Performance Review

You can review content performance ahead of each release to find slow content before it reaches your users.

For example, before you publish a new Flow to Production, you can export the diagnostics logs to identify steps that exceed the recommended time thresholds. You can then review the recommended actions, make the necessary changes, and export the logs again to verify that the issues no longer occur.

Use the following steps to review content performance before a release:

Preview your content on each page where it appears, in the environment you plan to release to.
Export the diagnostics logs for each page.
In the meta data file, go to the System health timing summary section, and then sort the rows by Breach Amount (ms) to find the biggest breaches first.
In the content information file, find the content items with the largest breaches. For each item, review the Is it Evaluated on the page, Is it Displayed on the page, and timing columns.
Review the Diagnostics recommended Action Item and System Health Summary columns for each item.
Update the content based on the recommended actions.
Export the diagnostics logs again to confirm that the breaches no longer appear.
Share the final files with your IT or security team as evidence for their approval.