Suggestion Bar
The SuggestionBar is a widget that displays several suggestions. Typically used on a PDP, it currently displays hard-coded suggestions but there are future plans to make them more dynamic and model generated. It supports an optional animation mode that is tracked in analytics events.
Analytics Event Triggers
Widget Rendered
This trigger occurs when the widget is rendered on the screen. It will still trigger if the widget is covered up by other content or is hidden through the use of opacity or other visual tricks.
Event: [Spiffy] Chat Component Visible
chat_component_visible.chat_component
suggestion_bar
chat_component_visible.animated
<animated>
These events are part of the V3 Envive event schema.
Event: [Envive] Widget Rendered
context.page_type
<page_type>
context.page_id
<page_id>
trigger.interaction_id
<interaction_id>
trigger.widget
suggestion_bar
Widget Clicked
This trigger occurs when the user clicks on one of the suggestion buttons triggering its interaction.
Two events fire on click.
Event 1: [Spiffy] Chat User Message Input
chat_user_message_input.message_id
<message_id>
chat_user_message_input.message_role
user
chat_user_message_input.message_type
query_typed
chat_user_message_input.message_metadata
{ "content": <text of button>, "created_at": <current_time>, "user_typed": false }
Event 2: [Spiffy] Chat Component Expanded
chat_component_expanded.message_metadata
{ "trigger_location": "top_reviews_snippet" }
These events are part of the V3 Envive event schema.
Three events fire on suggestion click.
Event 1: [Envive] Widget Interaction
context.page_type
<page_type>
context.page_id
<page_id>
trigger.interaction_id
<interaction_id>
trigger.widget
suggestion_bar
trigger.widget_interaction
suggestion_clicked
trigger.widget_interaction_data
{ suggestion_id: <suggestion_id> }
Event 2: [Envive] Chat Request
context.page_type
<page_type>
context.page_id
<page_id>
trigger.widget
suggestion_bar
trigger.interaction_id
<interaction_id>
chat.request_text
<request_text>
chat.suggestion_id
<suggestion_id>
chat.user_typed
false
Event 3: [Envive] Widget Rendered (for the floating_chat that appears)
context.page_type
<page_type>
context.page_id
<page_id>
trigger.interaction_id
<interaction_id>
trigger.widget
floating_chat
Widget Hovered
This trigger occurs when the user hovers their mouse over the widget triggering it to go into its expanded state. Not currently emitting any events.
None — not currently tracked.
These events are part of the V3 Envive event schema.
Event: [Envive] Widget Interaction
context.page_type
<page_type>
context.page_id
<page_id>
trigger.interaction_id
<interaction_id>
trigger.widget
suggestion_bar
trigger.widget_interaction
widget_hovered
Suggestion Scrolled
This trigger occurs when the user scrolls the suggestions manually. Not currently emitting any events.
None — not currently tracked.
These events are part of the V3 Envive event schema.
Event: [Envive] Widget Interaction
context.page_type
<page_type>
context.page_id
<page_id>
trigger.interaction_id
<interaction_id>
trigger.widget
suggestion_bar
trigger.widget_interaction
suggestion_scrolled
Last updated