Session AI Tag Setup Guide | Client-Side Tags

The Tealium tag for Session AI simplifies the integration of a website with the Session AI platform. Specifically, it facilitates the injection and initialization of the Session AI SDK, the collection and sending of visitor events, and the setting of a customer identifier for signed-in users.

For additional information about the Session AI tag, see Session AI Tealium Tag and Ecommerce Event Schema from Session AI.

Tag configuration

Navigate to the Tag Marketplace to add a new tag. For more information, see About tags.

When adding the tag, configure the following settings:

Access Token: Access token generated by the Session AI server-side tools.
Inject widget container: This widget container is used for rendering user experience content that is triggered by Session AI.
Publish Locations: Select the publish environments and ensure that your API keys are valid for these environments.
Bundle Flag: Set to ON for optimal page performance.
Advanced Settings: We recommend using the default values for the following settings:
- Send Flag: Determines whether to send events to Session AI. The default value is ON.
- Tag Timing: Determines when to fire the tag. The default is DOM Ready. Selecting DOM Ready minimizes impact on page rendering.
- Synchronous Load Type: Determines whether to synchronously load the tag. The default is OFF.

Load rules

Session AI recommends setting the Session AI SDK and tag load rules to All Pages and Events (default) for proper data collection and visitor interaction. For more information, see About load rules.

Data mappings

Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For more information, see About data mappings.

The available categories are:

Standard

Variable	Data Type	Description
`customerId`	String	Customer ID (Overrides `_ccustid`)
`logged_in`	Boolean	Logged in status. Available values are Y or N.

E-Commerce

For more information about e-commerce parameters, see Ecommerce Event Schema in the Session AI documentation.

Variable	Data Type	Description
`category`	String	Category
`product_id`	String	Product ID
`sku`	String	SKU
`search_term`	String	Search term
`result_count`	Number	Result count
`name`	String	Name
`price`	Number	Price
`list_price`	Number	List price
`order_id`	String	Order ID (Overrides `_corder`)
`order_total`	Number	Order total (Overrides `_ctotal`)
`discount`	Number	Discount
`currency`	String	Currency
`taxes`	Number	Taxes (Overrides `_ctax`)
`shipping`	Number	Shipping (Overrides `_cship`)
`item_total`	Number	Item total
`filter`	String	Filter
`sort_field`	String	Sort field
`sort_order`	String	Sort order
`coupons.code`	Array	Coupons code (Overrides `_cpromo`)
`coupons.value`	Array	Coupons value
`coupons.currency`	Array	Coupons currency
`coupons.type`	Array	Coupons type
`coupons.threshold`	Array	Coupons threshold
`coupons.method`	Array	Coupons method
`referrer_id`	String	Referrer ID
`items.quantity`	Array	Items quantity (Overrides `_cquan`)
`items.price`	Array	Items price (Overrides `_cprice`)
`items.list_price`	Array	Items list price
`items.sku`	Array	Items SKU (Overrides `_csku`)
`items.name`	Array	(Optional) Items name (Overrides `_cprodname`)
`items.productId`	Array	Items product ID (Overrides `_cprod`)
`items.category`	Array	(Optional) Items category (Overrides `_ccat`)
`items.currency`	Array	(Optional) Items currency (Overrides `_ccurrency`)
`items.item_coupon.code`	Array	(Optional) Items coupon code
`items.item_coupon.value`	Array	(Optional) Items coupon value
`items.item_coupon.currency`	Array	(Optional) Items coupon currency
`items.item_coupon.type`	Array	(Optional) Items coupon type
`items.item_coupon.threshold`	Array	(Optional) Items coupon threshold
`items.item_coupon.method`	Array	(Optional) Items coupon method
`updated_items.quantity`	Array	Updated items quantity (Overrides `_cquan`)
`updated_items.price`	Array	Updated items price (Overrides `_cprice`)
`updated_items.list_price`	Array	Updated items list price
`updated_items.sku`	Array	Updated items SKU (Overrides `_csku`)
`updated_items.name`	Array	Updated items name (Overrides `_cprodname`)
`updated_items.productId`	Array	Updated items product ID (Overrides `_cprod`)
`updated_items.category`	Array	Updated items category (Overrides `_ccat`)
`updated_items.currency`	Array	Updated items currency (Overrides `_ccurrency`)
`updated_items.item_coupon.code`	Array	Updated items coupon code
`updated_items.item_coupon.value`	Array	Updated items value
`updated_items.item_coupon.currency`	Array	Updated items currency
`updated_items.item_coupon.type`	Array	Updated items type
`updated_items.item_coupon.threshold`	Array	Updated items threshold
`updated_items.item_coupon.method`	Array	Updated items method

Initialization

Variable	Date Type	Description
`email`	String	Unique email address
`phone`	String	Unique phone number
`fb`	String	Facebook ID

Event Triggers

To map events, refer to Create an Event Mapping

Variable	Description
`view_home`	View home
`view_category`	View category
`view_product`	View product
`update_cart`	Update cart
`search`	Search
`apply_filter`	Apply filter
`select_sku`	Select SKU
`view_cart`	View cart
`add_to_cart`	Add to cart
`begin_checkout`	Begin checkout
`add_shipping_info`	Add shipping info
`add_payment_info`	Add payment info
`purchase`	Purchase
`user_login`	User login
`user_logout`	User logout
`user_register`	User register
`add_wishlist`	Add wishlist
`view_wishlist`	View wishlist
`update_wishlist`	Update wishlist
`view_review`	View review
`add_review`	Add review
`view_product_question`	View product question
`add_product_question`	Add product question
`view_landingpage`	View landing page
`view_faq`	View faq
`set_storelocation`	Set store location
`setCustomerId`	Set customer ID
`addCustomerInfo`	Add customer info
`registerWidget`	Register widget
`Custom`	Custom

Event-specific Parameters

To map events, refer to Create an Event Mapping

Variable	Data Type	Description
`email`	String	Unique email address
`phone`	String	Unique phone number
`fb`	String	Facebook ID
`logged_in`	Boolean	Logged in status. Available values are Y or N.
`category`	String	Category
`product_id`	String	Product ID
`sku`	String	SKU
`search_term`	String	Search term
`result_count`	Number	Result count
`name`	String	Name
`price`	Number	Price
`list_price`	Number	List price
`order_id`	String	Order ID
`order_total`	Number	Order total
`discount`	Number	Discount
`currency`	String	Currency
`taxes`	Number	Taxes
`shipping`	Number	Shipping
`item_total`	Number	Item total
`filter`	JSON object	(Optional) Filter
`sort_field`	String	(Optional) Sort field
`sort_order`	String	(Optional) Sort order
`coupons.code`	Array	(Optional) Coupons code (Overrides `_cpromo`)
`coupons.value`	Array	(Optional) Coupons value
`coupons.currency`	Array	(Optional) Coupons currency
`coupons.type`	Array	(Optional) Coupons type
`coupons.threshold`	Array	(Optional) Coupons threshold
`coupons.method`	Array	(Optional) Coupons method
`referrer_id`	String	Referrer id
`items.quantity`	Array	Items quantity (Overrides `_cquan`)
`items.price`	Array	Items price (Overrides `_cprice`)
`items.list_price`	Array	Items list price
`items.sku`	Array	Items sku (Overrides `_csku`)
`items.name`	Array	Items name (Overrides `_cprodname`)
`items.productId`	Array	Items product id (Overrides `_cprod`)
`items.category`	Array	Items category (Overrides `_ccat`)
`items.currency`	Array	Items currency (Overrides `_ccurrency`)
	`items.item_coupon.code`	Array
`items.item_coupon.value`	Array	Items coupon value
`items.item_coupon.currency`	Array	Items coupon currency
`items.item_coupon.type`	Array	Items coupon type
`items.item_coupon.threshold`	Array	Items coupon threshold
`items.item_coupon.method`	Array	Items coupon method
`updated_items.quantity`	Array	Updated items quantity (Overrides `_cquan`)
`updated_items.price`	Array	Updated items price (Overrides `_cprice`)
`updated_items.list_price`	Array	Updated items list price
`updated_items.sku`	Array	Updated items SKU (Overrides `_csku`)
`updated_items.name`	Array	Updated items name (Overrides `_cprodname`)
`updated_items.productId`	Array	Updated items product ID (Overrides `_cprod`)
`updated_items.category`	Array	Updated items category (Overrides `_ccat`)
`updated_items.currency`	Array	Updated items currency (Overrides `_ccurrency`)
`updated_items.item_coupon.code`	Array	Updated items coupon code
`updated_items.item_coupon.value`	Array	Updated items value
`updated_items.item_coupon.currency`	Array	Updated items currency
`updated_items.item_coupon.type`	Array	Updated items type
`updated_items.item_coupon.threshold`	Array	Updated items threshold
`updated_items.item_coupon.method`	Array	Updated items method
`customerId`	String	Customer ID
`attrName`	String	Attribute name
`attrValue`	String	Attribute value
`Custom_Parameter`	Event	Custom parameter
`onitialize`	Event	Initialize
`view_home`	Event	View home
`view_category`	Event	View category
`view_product`	Event	View product
`update_cart`	Event	Update cart
`search`	Event	Search
`apply_filter`	Event	Apply filter
`select_sku`	Event	Select SKU
`view_cart`	Event	View cart
`add_to_cart`	Event	Add to cart
`begin_checkout`	Event	Begin checkout
`add_shipping_info`	Event	Add shipping information
`add_payment_info`	Event	Add payment information
`purchase`	Event	Purchase
`user_login`	Event	User login
`user_logout`	Event	User logout
`user_register`	Event	User register
`add_wishlist`	Event	Add wishlist
`view_wishlist`	Event	View wishlist
`update_wishlist`	Event	Update wishlist
`view_review`	Event	View review
`add_review`	Event	Add review
`view_product_question`	Event	View product question
`add_product_question`	Event	Add product question
`view_landingpage`	Event	View landing page
`view_faq`	Event	View FAQ
`set_storelocation`	Event	Set store location
`setCustomerId`	Event	Set customer ID
`addCustomerInfo`	Event	Add customer information
`Custom_Event`	Event	Custom event