Skip to main content

Events and Data

This document provides a comprehensive reference for all the events tracked by the Onlive analytics system, along with their corresponding data structures. Each event is detailed with its properties, data types, and descriptions to help you understand and leverage the tracking data

Table of Contents

Events

Element Click element_click

Captures when a user clicks on an element

PropertyData TypePossible ValuesDescription
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
element_labelstring"submit", "cancel", "open chat", "close chat"The label or text of the interacted element
element_typestring (enum)"input", "button", "link", "checkbox", "radio", "select", "switch", "rating", "textarea", "carousel", "calendar", "map", "other"The type of element that was interacted with
element_dataobject{ "target_url": "https://example.com" }Key-value pairs containing the element data
room_id?string (UUID)UUID formatUnique identifier for the room
room_group_id?string (UUID)UUID formatUnique identifier for the room group
room_dataobject{ "ai_assistant": "lola" }Key-value pairs containing the room data
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Element Data
element_label: "submit",
element_type: "button"
element_data: {
target_link: "https://example.com",
}

// Form Data
form_name: "register",
step_name: "step_1",
step_number: 1,
step_final: true,
step_group_name: "user_info",
step_group_number: 1,

// Room Data
room_id: "123e4567-e89b-12d3-a456-426614174000",
room_group_id: "123e4567-e89b-12d3-a456-426614174000",

// Organization Data
organization_id: "123e4567-e89b-12d3-a456-426614174000",
organization_name: "Onlive Site.",
organization_demo: true,

// Session Data
guest_id: "550e8400-e29b-41d4-a716-446655440000",
interaction_id: "98765432-e89b-12d3-a456-426614174000",

// Origin Data
utm_source: "google",
utm_medium: "cpc",
utm_campaign: "spring_sale",
utm_term: "online_support",
utm_content: "banner_ad",
page_url: "https://example.com/products/item123",
page_referrer: "https://google.com/search",
origin_medium: "web",
origin_source: "facebook",
origin_custom_1: "promo_code_123",
origin_custom_2: "premium_tier",
origin_custom_3: "seasonal_offer",

// Widget Data
widget_id: "abc12345-e89b-12d3-a456-426614174000",
widget_name: "lola_assistant",
widget_type: "OnliveAppChatbot",
widget_module: "chat",
widget_version: "1.2.0",

// Service Data
service_name: "ms-chat",
service_version: "3.1.4",

// Extra Data
extra: {
car_brand: "cupra",
car_model: "leon"
}
}

Element Interaction element_interaction

Captures when a user interacts with a specific element.

PropertyData TypePossible ValuesDescription
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
element_labelstring"submit", "cancel", "open chat", "close chat"The label or text of the interacted element
element_typestring (enum)"input", "button", "link", "checkbox", "radio", "select", "switch", "rating", "textarea", "carousel", "calendar", "map", "other"The type of element that was interacted with
element_dataobject{ "target_url": "https://example.com" }Key-value pairs containing the element data
room_id?string (UUID)UUID formatUnique identifier for the room
room_group_id?string (UUID)UUID formatUnique identifier for the room group
room_dataobject{ "ai_assistant": "lola" }Key-value pairs containing the room data
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Element Data
element_label: "name",
element_type: "input"
element_data: {
target_link: "https://example.com",
}

// Form Data
form_name: "register",
step_name: "step_1",
step_number: 1,
step_final: true,
step_group_name: "user_info",
step_group_number: 1,

// Room Data
room_id: "123e4567-e89b-12d3-a456-426614174000",
room_group_id: "123e4567-e89b-12d3-a456-426614174000",

// Organization Data
organization_id: "123e4567-e89b-12d3-a456-426614174000",
organization_name: "Onlive Site.",
organization_demo: true,

// Session Data
guest_id: "550e8400-e29b-41d4-a716-446655440000",
interaction_id: "98765432-e89b-12d3-a456-426614174000",

// Origin Data
utm_source: "google",
utm_medium: "cpc",
utm_campaign: "spring_sale",
utm_term: "online_support",
utm_content: "banner_ad",
page_url: "https://example.com/products/item123",
page_referrer: "https://google.com/search",
origin_medium: "web",
origin_source: "facebook",
origin_custom_1: "promo_code_123",
origin_custom_2: "premium_tier",
origin_custom_3: "seasonal_offer",

// Widget Data
widget_id: "abc12345-e89b-12d3-a456-426614174000",
widget_name: "lola_assistant",
widget_type: "OnliveAppChatbot",
widget_module: "chat",
widget_version: "1.2.0",

// Service Data
service_name: "ms-chat",
service_version: "3.1.4",

// Extra Data
extra: {
car_brand: "cupra",
car_model: "leon"
}
}

Form Error form_error

Captures a error in a form submission

PropertyData TypePossible ValuesDescription
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Form Data
"form_name": "register",
"form_error": "Invalid data",
"step_name": "step_1",
"step_number": 1,
"step_final": true,
"step_group_name": "user_info",
"step_group_number": 1,

// Organization Data
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_name": "Onlive Site.",
"organization_demo": true,

// Session Data
"guest_id": "550e8400-e29b-41d4-a716-446655440000",
"interaction_id": "98765432-e89b-12d3-a456-426614174000",

// Origin Data
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring_sale",
"utm_term": "online_support",
"utm_content": "banner_ad",
"page_url": "https://example.com/products/item123",
"page_referrer": "https://google.com/search",
"origin_medium": "web",
"origin_source": "facebook",
"origin_custom_1": "promo_code_123",
"origin_custom_2": "premium_tier",
"origin_custom_3": "seasonal_offer",

// Widget Data
"widget_id": "abc12345-e89b-12d3-a456-426614174000",
"widget_name": "lola_assistant",
"widget_type": "OnliveAppChatbot",
"widget_module": "chat",
"widget_version": "1.2.0",

// Service Data
"service_name": "ms-chat",
"service_version": "3.1.4",

// Extra Data
"extra": {
"car_brand": "cupra",
"car_model": "leon"
}
}

Form Interaction form_interaction

Captures when a user interacts a form

PropertyData TypePossible ValuesDescription
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
room_id?string (UUID)UUID formatUnique identifier for the room
room_group_id?string (UUID)UUID formatUnique identifier for the room group
room_dataobject{ "ai_assistant": "lola" }Key-value pairs containing the room data
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Form Data
"form_name": "register",
"step_name": "step_1",
"step_number": 1,
"step_final": true,
"step_group_name": "user_info",
"step_group_number": 1,

// Room Data
"room_id": "123e4567-e89b-12d3-a456-426614174000",
"room_group_id": "123e4567-e89b-12d3-a456-426614174000",

// Organization Data
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_name": "Onlive Site.",
"organization_demo": true,

// Session Data
"guest_id": "550e8400-e29b-41d4-a716-446655440000",
"interaction_id": "98765432-e89b-12d3-a456-426614174000",

// Origin Data
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring_sale",
"utm_term": "online_support",
"utm_content": "banner_ad",
"page_url": "https://example.com/products/item123",
"page_referrer": "https://google.com/search",
"origin_medium": "web",
"origin_source": "facebook",
"origin_custom_1": "promo_code_123",
"origin_custom_2": "premium_tier",
"origin_custom_3": "seasonal_offer",

// Widget Data
"widget_id": "abc12345-e89b-12d3-a456-426614174000",
"widget_name": "lola_assistant",
"widget_type": "OnliveAppChatbot",
"widget_module": "chat",
"widget_version": "1.2.0",

// Service Data
"service_name": "ms-chat",
"service_version": "3.1.4",

// Extra Data
"extra": {
"car_brand": "cupra",
"car_model": "leon"
}
}

Form Submit form_submit

Captures when a user submits a form

PropertyData TypePossible ValuesDescription
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
room_id?string (UUID)UUID formatUnique identifier for the room
room_group_id?string (UUID)UUID formatUnique identifier for the room group
room_dataobject{ "ai_assistant": "lola" }Key-value pairs containing the room data
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Form Data
form_name: "register",
form_data: {
name: "John Doe",
email: "[email protected]"
},
step_name: "step_1",
step_number: 1,
step_final: true,
step_group_name: "user_info",
step_group_number: 1

// Room Data
room_id: "123e4567-e89b-12d3-a456-426614174000",
room_group_id: "123e4567-e89b-12d3-a456-426614174000",

// Organization Data
organization_id: "123e4567-e89b-12d3-a456-426614174000",
organization_name: "Onlive Site.",
organization_demo: true,

// Session Data
guest_id: "550e8400-e29b-41d4-a716-446655440000",
interaction_id: "98765432-e89b-12d3-a456-426614174000",

// Origin Data
utm_source: "google",
utm_medium: "cpc",
utm_campaign: "spring_sale",
utm_term: "online_support",
utm_content: "banner_ad",
page_url: "https://example.com/products/item123",
page_referrer: "https://google.com/search",
origin_medium: "web",
origin_source: "facebook",
origin_custom_1: "promo_code_123",
origin_custom_2: "premium_tier",
origin_custom_3: "seasonal_offer",

// Widget Data
widget_id: "abc12345-e89b-12d3-a456-426614174000",
widget_name: "lola_assistant",
widget_type: "OnliveAppChatbot",
widget_module: "chat",
widget_version: "1.2.0",

// Service Data
service_name: "ms-chat",
service_version: "3.1.4",

// Extra Data
extra: {
car_brand: "cupra",
car_model: "leon"
}
}

Impression impression

Captures when a user views an widget, page, form, etc

PropertyData TypePossible ValuesDescription
channel_id?string (UUID)UUID formatUnique identifier for the channel
channel_url?string"https://example.com/channel/12345"URL of the channel
event_id?string (UUID)UUID formatUnique identifier for the event
event_name?string"Annual Conference 2024"Name of the event
event_typestring (enum)"one_to_many"Type of the event
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
room_id?string (UUID)UUID formatUnique identifier for the room
room_group_id?string (UUID)UUID formatUnique identifier for the room group
room_dataobject{ "ai_assistant": "lola" }Key-value pairs containing the room data
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Specific event data
impression_type: "page"
impression_delay_ms: 1500,

// Organization Data
organization_id: "123e4567-e89b-12d3-a456-426614174000",
organization_name: "Onlive Site.",
organization_demo: true,

// Session Data
guest_id: "550e8400-e29b-41d4-a716-446655440000",
interaction_id: "98765432-e89b-12d3-a456-426614174000",

// Origin Data
utm_source: "google",
utm_medium: "cpc",
utm_campaign: "spring_sale",
utm_term: "online_support",
utm_content: "banner_ad",
page_url: "https://example.com/products/item123",
page_referrer: "https://google.com/search",
origin_medium: "web",
origin_source: "facebook",
origin_custom_1: "promo_code_123",
origin_custom_2: "premium_tier",
origin_custom_3: "seasonal_offer",

// Widget Data
widget_id: "abc12345-e89b-12d3-a456-426614174000",
widget_name: "lola_assistant",
widget_type: "OnliveAppChatbot",
widget_module: "chat",
widget_version: "1.2.0",

// Service Data
service_name: "ms-chat",
service_version: "3.1.4",

// Extra Data
extra: {
car_brand: "cupra",
car_model: "leon"
},

// Channel Data
channel_id: "794a2792-3aa5-522d-8606-6c1f39b62b50",
channel_url: "website_chat",

// Event Data
event_id: "d8c7cf8d-a0f9-5482-986f-2b2ea46243f6",
event_name: "Product showcase",
event_type: "one_to_many",

// Form Data
form_name: "register",
step_name: "step_1",
step_number: 1,
step_final: true,
step_group_name: "user_info",
step_group_number: 1

// Room Data
room_id: "123e4567-e89b-12d3-a456-426614174000",
room_group_id: "123e4567-e89b-12d3-a456-426614174000",
}

Query Empty query_empty

Captures when a search, filter or query returns no results

PropertyData TypePossible ValuesDescription
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Specific event data
"query_source": "search_bar",
"query_term": "rare product name",
"query_duration_ms": 350,

// Form Data
"form_name": "register",
"step_name": "step_1",
"step_number": 1,
"step_final": true,
"step_group_name": "user_info",
"step_group_number": 1,

// Organization Data
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_name": "Onlive Site.",
"organization_demo": true,

// Session Data
"guest_id": "550e8400-e29b-41d4-a716-446655440000",
"interaction_id": "98765432-e89b-12d3-a456-426614174000",

// Origin Data
"utm_source": "google",
"utm_medium": "cpc",
"utm_campaign": "spring_sale",
"utm_term": "online_support",
"utm_content": "banner_ad",
"page_url": "https://example.com/products/item123",
"page_referrer": "https://google.com/search",
"origin_medium": "web",
"origin_source": "facebook",
"origin_custom_1": "promo_code_123",
"origin_custom_2": "premium_tier",
"origin_custom_3": "seasonal_offer",

// Widget Data
"widget_id": "abc12345-e89b-12d3-a456-426614174000",
"widget_name": "lola_assistant",
"widget_type": "OnliveAppChatbot",
"widget_module": "chat",
"widget_version": "1.2.0",

// Service Data
"service_name": "ms-chat",
"service_version": "3.1.4",

// Extra Data
"extra": {
"car_brand": "cupra",
"car_model": "leon"
}
}

Task Success task_success

Captures when a task, process o pipeline is successfully completed

PropertyData TypePossible ValuesDescription
task_namestring"login_task", "checkout_process"The name of the task
task_type?string"authentication", "payment", "user_interaction"The type/category of the task
task_duration_ms?number1500, 3000Duration of the task in milliseconds
task_dataobject{ "step": "2", "success": true, "items_count": 5 }Additional data related to the task as key-value pairs
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to
room_id?string (UUID)UUID formatUnique identifier for the room
room_group_id?string (UUID)UUID formatUnique identifier for the room group
room_dataobject{ "ai_assistant": "lola" }Key-value pairs containing the room data
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

Example

{
// Task Data
task_name: "Data Import",
task_type: "import",
task_duration_ms: 3500,
task_data: {
custom_field: "value",
items_processed: 150
}

// Form Data
form_name: "register",
step_name: "step_1",
step_number: 1,
step_final: true,
step_group_name: "user_info",
step_group_number: 1,

// Room Data
room_id: "123e4567-e89b-12d3-a456-426614174000",
room_group_id: "123e4567-e89b-12d3-a456-426614174000",

// Organization Data
organization_id: "123e4567-e89b-12d3-a456-426614174000",
organization_name: "Onlive Site.",
organization_demo: true,

// Session Data
guest_id: "550e8400-e29b-41d4-a716-446655440000",
interaction_id: "98765432-e89b-12d3-a456-426614174000",

// Origin Data
utm_source: "google",
utm_medium: "cpc",
utm_campaign: "spring_sale",
utm_term: "online_support",
utm_content: "banner_ad",
page_url: "https://example.com/products/item123",
page_referrer: "https://google.com/search",
origin_medium: "web",
origin_source: "facebook",
origin_custom_1: "promo_code_123",
origin_custom_2: "premium_tier",
origin_custom_3: "seasonal_offer",

// Widget Data
widget_id: "abc12345-e89b-12d3-a456-426614174000",
widget_name: "lola_assistant",
widget_type: "OnliveAppChatbot",
widget_module: "chat",
widget_version: "1.2.0",

// Service Data
service_name: "ms-chat",
service_version: "3.1.4",

// Extra Data
extra: {
car_brand: "cupra",
car_model: "leon"
}
}

Data

Agent agent

Agent data schema

PropertyData TypePossible ValuesDescription
agent_id?string (UUID)UUID formatUnique identifier for the agent
agent_email?string"agentThe email address of the agent
agent_phone?string"+1234567890", "555-123-4567"The phone number of the agent
agent_name?string"John Doe", "Jane Smith"The name of the agent
agent_first_name?string"John", "Jane"The first name of the agent
agent_last_name?string"Doe", "Smith"The last name of the agent

Browser browser

Browser data schema

PropertyData TypePossible ValuesDescription
user_agent?string"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"The user agent string
os_version?string"10.0", "11.2.3"The operating system version
os_name?string"Windows", "macOS", "iOS", "Android"The operating system name
browser_version?string"91.0.4472.124", "14.1.2"The browser version
browser_name?string"Chrome", "Firefox", "Safari", "Edge"The browser name
device_vendor?string"Apple", "Samsung", "Google"The device manufacturer/vendor
device_model?string"iPhone 12", "Galaxy S21", "Pixel 6"The device model
device_type?string"mobile", "tablet", "desktop"The type of device

Channel channel

Channel data schema

PropertyData TypePossible ValuesDescription
channel_id?string (UUID)UUID formatUnique identifier for the channel
channel_url?string"https://example.com/channel/12345"URL of the channel

Element element

Element data schema

PropertyData TypePossible ValuesDescription
element_labelstring"submit", "cancel", "open chat", "close chat"The label or text of the interacted element
element_typestring (enum)"input", "button", "link", "checkbox", "radio", "select", "switch", "rating", "textarea", "carousel", "calendar", "map", "other"The type of element that was interacted with
element_dataobject{ "target_url": "https://example.com" }Key-value pairs containing the element data

Evaluation evaluation

Evaluation data schema

PropertyData TypePossible ValuesDescription
evaluation_option?number5The selected evaluation option identifier
evaluation_category?string"performance"The category to which this evaluation belongs
evaluation_comment?string"Great progress shown in this area"Additional comments or feedback for the evaluation

Event event

Event data schema

PropertyData TypePossible ValuesDescription
event_id?string (UUID)UUID formatUnique identifier for the event
event_name?string"Annual Conference 2024"Name of the event
event_typestring (enum)"one_to_many"Type of the event

Extra extra

Extra data schema

PropertyData TypePossible ValuesDescription
extraobject{ car_model: "cupra", car_year: 2025 }Optional field that allows sending additional custom data with the event

Form form

Form data schema

PropertyData TypePossible ValuesDescription
form_name?string"registration"The name of the form
form_dataobject{ "first_name": "John", "first_name": "Doe", "email": "john" }Key-value pairs containing the form data
form_error?string"Email is required"Error message if form validation fails
step_name?string"contact"The name of the current step in the form flow
step_number?number2The current step number
step_initial?booleantrue, falseIndicates if this is the initial step in the form
step_final?booleantrue, falseIndicates if this is the final step in the form
step_group_name?string"user_details"The name of the group this step belongs to
step_group_number?number1The number of the group this step belongs to

Geolocation geolocation

Geolocation data schema

PropertyData TypePossible ValuesDescription
ipv4?string127.0.0.1The IP address
ip_country_name?string"United States"The country name of the IP address
ip_country_code?string"US"The country code of the IP address
ip_state?string"California"The state/region of the IP address
ip_city?string"San Francisco"The city of the IP address

Organization organization

Organization data schema

PropertyData TypePossible ValuesDescription
organization_id?string (UUID)UUID formatUnique identifier for the organization
organization_name?string"Onlive Site.", "Example Corp"Name of the organization
organization_demo?booleantrue, falseDetermines if the organization is a demo account

Origin origin

Origin data schema

PropertyData TypePossible ValuesDescription
utm_source?string"google", "newsletter", "twitter"UTM source parameter identifies which site sent the traffic
utm_medium?string"cpc", "banner", "email"UTM medium parameter identifies what type of link was used
utm_campaign?string"spring_sale", "product_launch", "black_friday"UTM campaign parameter identifies a specific product promotion or strategic campaign
utm_term?string"running+shoes", "affordable+laptops"UTM term parameter identifies search terms
utm_content?string"banner", "text_link", "image1"UTM content parameter identifies what specifically was clicked
page_url?string"https://example.com/products/item123"The URL of the page where the event occurred
page_referrer?string"https://google.com", "https://facebook.com/shared_post"The URL of the referring page
origin_mediumstring (enum)"email", "sms", "push", "web", "app"The communication medium from which the event originated
origin_sourcestring (enum)"google", "facebook", "twitter", "linkedin"The source of the origin, such as a specific platform or service
origin_custom_1?string"promo_code_123", "partner_campaign", "influencer_name"First custom origin parameter for tracking custom sources
origin_custom_2?string"region_europe", "premium_tier", "returning_customer"Second custom origin parameter for tracking custom sources
origin_custom_3?string"seasonal_offer", "flash_sale", "loyalty_program"Third custom origin parameter for tracking custom sources

Preference preference

Preference data schema

PropertyData TypePossible ValuesDescription
language?string"es", "en", "en-US"The detected language
timezone?string"UTC", "America/New_York", "Europe/Madrid"The detected timezone

Product product

Product data schema

PropertyData TypePossible ValuesDescription
product_id?string"prod_12345"Unique identifier for the product
product_name?string"Premium Widget Pro"The display name of the product
product_code?string"WDG-PRO-001"Internal product code or SKU

Room room

Room data schema

PropertyData TypePossible ValuesDescription
room_id?string (UUID)UUID formatUnique identifier for the room
room_group_id?string (UUID)UUID formatUnique identifier for the room group
room_dataobject{ "ai_assistant": "lola" }Key-value pairs containing the room data

Service service

Service data schema

PropertyData TypePossible ValuesDescription
service_name?string"ms-chat", "ms-api",Name of the service
service_version?string"1.0.0", "2.3.5"Version of the service

Session session

Session data schema

PropertyData TypePossible ValuesDescription
guest_id?string (UUID)UUID formatUnique identifier for the guest/user
interaction_id?string (UUID)UUID formatUnique identifier for the current interaction/session

Task task

Task data schema

PropertyData TypePossible ValuesDescription
task_namestring"login_task", "checkout_process"The name of the task
task_type?string"authentication", "payment", "user_interaction"The type/category of the task
task_duration_ms?number1500, 3000Duration of the task in milliseconds
task_dataobject{ "step": "2", "success": true, "items_count": 5 }Additional data related to the task as key-value pairs

Tracker tracker

Tracker data schema

PropertyData TypePossible ValuesDescription
tracker_name?string"js-tracker", "py-tracker", "node-tracker"The name of the tracker
tracker_version?string"1.0.0"The version of the tracker

User user

User data schema

PropertyData TypePossible ValuesDescription
user_id?string (UUID)UUID formatUnique identifier for the user
user_email?string"userThe email address of the user
user_phone?string"+1234567890", "555-123-4567"The phone number of the user
user_name?string"John Doe", "Jane Smith"The name of the user
user_first_name?string"John", "Jane"The first name of the user
user_last_name?string"Doe", "Smith"The last name of the user

Widget widget

Widget data schema

PropertyData TypePossible ValuesDescription
widget_id?string (UUID)UUID formatUnique identifier for the widget
widget_name?string"lola_assistant", "tv_channel"Name of the widget
widget_type?string"OnliveAppTv", "OnliveAppChatbot", "OnliveAppFlow"Type or category of the widget
widget_module?string"chat", "flow", "meet"Specific module of the widget
widget_version?string"1.0.0", "2.3.5"Version of the widget