A/B test events

A/B test events are the primary data points used to track and analyze the effectiveness of different variants. Use them to evaluate Clarity's overall performance. Each event also carries the default event attributes.

actual_show

Tracked when a trigger element is actually visible on the shopper's screen.

Stricter than the show event. While show can fire on scroll activity, actual_show requires the element to be physically visible within the shopper's current screen (viewport).

Attributes

AttributeDescriptionValues
actionEvent action type.actual_show
componentTrigger surface type.Same as show
component_templateTemplate version.Same as show
trigger_context_product_idsProduct IDs extracted from the page by the trigger.Array of product IDs
trigger_conversation_starters_listConversation starter texts shown in the trigger.Array of strings
trigger_conversation_starters_is_generatedWhether the conversation starters were AI-generated.true, false

bundle_show

Tracked when the Clarity interface has finished rendering for the shopper.

Attributes

AttributeDescriptionValues
actionEvent action type.bundle_show
typeSub-type.bundle_show
component_templateTemplate version of the use case.Example: PDP_EMBEDDED_v2, FLOATING_TRIGGER_v2

session_start

Tracked once per browsing session, at the start of the session. The conditions and timestamp match the system event session_start. This event always carries the global A/B variant information and is the canonical event for evaluating Clarity's overall performance.

In addition to the default attributes, session_start always carries experiment_id, experiment_source, global_rank, throttle_rank, global_variant_id, and global_variant_name.

Attributes

AttributeDescriptionValues
actionEvent action type.session_start
session_start_timestampSession start timestamp.Example: 1759516868154

show

Tracked when a Clarity element becomes visible.

Attributes

Attribute Description Values
action Event action type. show
component Surface type. The component attribute distinguishes between a trigger appearing, the chat widget appearing, the feedback survey appearing, and control-group impressions. PDP_EMBEDDED, PLP_EMBEDDED, PLP_BANNER, SEARCH_SUGGESTION, FLOATING_TRIGGER, CHAT, FEEDBACK_SURVEY

See description.

component_template Template version used for the element. PDP_EMBEDDED_v1, PLP_EMBEDDED_v1, PLP_BANNER_v1, SEARCH_SUGGESTION_v1, FLOATING_TRIGGER_v1, CHAT_v1, FEEDBACK_SURVEY_v2
chat_widget_state Identifies the current visibility mode of the interface.

Logged only when component=CHAT.

minimized (no bubble), bubble (minimized with initial-message bubble), open
chat_widget_size Identifies the chat widget size.

Logged only when component=CHAT and chat_widget_state=open.

large, small, half_screen, full_screen
conversation_state Tracks the specific state of the conversation.

Logged only when component=CHAT.

initial_message, welcome_message, home_screen, conversation, idle
chat_config Webchat configuration. Logged only when component=CHAT. JSON string
most_recently_clicked_trigger Banner name of the most recently clicked trigger. Logged only when component=CHAT. Example: Clarity-PLP-Embedded
chat_opened_from_trigger Banner name of the trigger that opened the chat. Logged only when component=CHAT and the chat opened from a trigger click. Banner name string
trigger_conversation_starters_list Conversation starter texts shown in the trigger. Logged only for trigger components. Array of strings
trigger_conversation_starters_is_generated Whether the conversation starters were AI-generated. Logged for PDP-embedded components. true, false
trigger_context_product_ids Product IDs extracted from the page by the trigger. Array of product IDs
initial_message Initial message text. Logged only when chat_widget_state=bubble. Message text
initial_message_quick_replies Quick replies shown with the initial message. Logged only when chat_widget_state=bubble. Array of strings
initial_message_product_ids Product IDs associated with the initial message. Logged only when chat_widget_state=bubble. Array of product IDs

component values

component valueDescription
PDP_EMBEDDEDThe trigger is embedded directly within a product detail page.
PLP_EMBEDDEDThe trigger is embedded within a product listing page.
PLP_BANNERThe trigger appears as a banner on a product listing page.
SEARCH_SUGGESTIONThe trigger appears within the search suggestions or autocomplete results.
FLOATING_TRIGGERThe trigger appears as a floating button that follows the shopper as they scroll.
CHATThe Clarity chat window appears.
FEEDBACK_SURVEYThe feedback survey appears after the Clarity experience.

use_case_session_start

Tracked once per banner_id per session, the first time a shopper eligible for that use case loads a page. Carries the same session_start_timestamp as the matching session_start event. Use it to count sessions in which a specific use case was eligible to render.

Attributes

AttributeDescriptionValues
actionEvent action type.use_case_session_start
session_start_timestampSession start timestamp.Example: 1759516868154
📘

Note

When multiple use cases are active on the same page, banner_id, banner_name, and banner_type reflect the most recently initialized trigger.


© Bloomreach, Inc. All rights reserved.