Clarity event tracking
Event tracking helps you understand how users interact with Clarity. Each interaction provides insights into engagement, performance, and potential issues. This article explains how Clarity captures events and how you can use this data to optimize Clarity’s impact.
Event types
Clarity automatically tracks various user actions, giving you a detailed view of engagement.
- User actions: When users open Clarity, click triggers, or navigate menus.
- Engagement: When users select or deselect products, click links, or chat with Clarity.
- Conversational flow: Tracks messages exchanged, Clarity’s responses, and any errors or warnings.
- User feedback: Records ratings (thumbs up and down) and survey responses.
Why event type matters
Each event type provides unique insights to improve Clarity’s performance.
- User actions: Analyze how users engage with Clarity’s interface. Based on usage patterns, refine placement and navigation.
- Engagement: Identify popular features, detect drop-off points, and optimize interactions.
- Conversational flow: Evaluate response quality, detect gaps, and flag frequent conversation abandonments.
- User feedback: Measure satisfaction, identify pain points, and refine messaging.
Tracked events
Clarity captures interactive elements to provide a full picture of user interactions. Regularly reviewing tracked data ensures event tracking remains accurate and relevant.
Clarity tracks 2 types of events:
- Clarity events: Provide evaluation data to measure engagement and impact.
- Clarity emergency events: Identify performance issues, such as errors or warnings.
Clarity event tracking
Clarity tracks events automatically based on user actions. The table outlines key event types.
| Event type | Action attribute | Description |
|---|---|---|
| Show | show | Triggers load on page refresh or when a chat widget or survey appears. |
| Trigger | trigger_clicked | User clicks a component leading to a Clarity conversation. |
| Menu click | menu_click | User interacts with Clarity’s menu. |
| Chat window state change | change_size, expand_from_bubble, expand_from_minimized, close_bubble, close_chat_from_minimized, minimize_from_open | User changes the size or visibility of the chat interface. |
| URL click | url_click | User clicks product cards or text links within the chat. |
| Open chat from trigger | expand_from_trigger | User expands the chat by clicking a banner or button. |
| Product select or deselect | product_select, product_deselect | User selects or deselects a product. |
| User response | user_respond | User responds to Clarity prompts. |
| Clarity response | clarity_respond | Clarity provides a text response. |
| Feedback closed | close_feedback | User closes feedback survey. |
| Thumbs up or down | thumbs_up, thumbs_down | User submits feedback or rate messages. |
| User submits feedback | submit_feedback | User scores or leaves feedback. |
Clarity safety event tracking
Clarity also tracks safety events to detect performance issues and errors. If an issue occurs, investigate and resolve it fast to ensure smooth functionality.
| Event type | Action attribute | Description |
|---|---|---|
| Error | clarity_error | Tracks when Clarity encountered a critical error. |
| Warning | clarity_warning | Tracks when Clarity encountered an error but wasn’t blocked or stopped. |
| Empty product ID | clarity_error | Tracked when the product ID is missing. |
| Invalid product ID | clarity_error | Tracked when the product ID isn't valid. |
| Health check failed | load_failed | Tracked when a system health check fails. |
| Product ID isn't a string | clarity_error | Tracked when the product ID returned from the implementation of getProductIds isn't returning a string. |
| Outside working hours | load_failed | Tracked when Clarity widgets don’t show due to configuration that limits the loading of Clarity within a time period. |
| Global Tag not loaded | load_failed | Tracked when the Global Clarity Tag fails to load due to script errors. |
Note
These are standard events. You can track additional events based on your implementation.
For response actions, see the Clarity safety article.
Non-Clarity events
To get a complete view of Clarity’s impact, track relevant external custom events:
- Required events:
cart_update,purchase,view_item - Recommended events:
checkout,view_category
Updated 2 days ago