Session AI Tag Setup Guide
This article describes how to set up the Session AI tag in your Tealium iQ Tag Management account.
Session AI is an in-session marketing platform for enterprise direct-to-consumer e-commerce businesses. Session AI uses advanced machine learning to understand short-term consumer behaviors at the moment using only clickstream data, without requiring any historical, demographic, or personally identifiable information.
Tag tips
- Use data mappings to dynamically override the standard configuration values.
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.
Load rules
Load the tag on all pages or set conditions for when your tag will load. 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 |
---|---|---|
accesstoken |
String | Access token |
base_url |
String | Base URL |
widgetType |
String | Widget type |
widgetCallback |
Function | Widget callback |
customerId |
String | Customer ID (Overrides _ccustid ) |
E-Commerce
Variable | Data Type | Description |
---|---|---|
logged_in |
BooleanY or N |
Logged in |
category |
String | Category |
product_id |
String | Product ID |
price_sale |
Number | Price sale |
price_orig |
Number | Price original |
sku |
String | SKU |
search_term |
String | Search term |
name |
String | Name |
price |
Number | Price |
list_price |
Number | List price |
variant.color |
String | Variant color |
variant.brand |
String | Variant brand |
variant.size |
String | Variant size |
cart.quantity |
Array | Cart quantity (Overrides _cquan ) |
cart.productId |
Array | Cart product ID (Overrides _cprod ) |
cart.priceSale |
Array | Cart price sale (Overrides _cprice ) |
cart.priceOrig |
Array | Cart price original |
cart.sku |
Array | Cart SKU (Overrides _csku ) |
cart.custom |
Array | Cart custom |
order_id |
String | Order ID (Overrides _corder ) |
order_total |
Number | Order total (Overrides _ctotal ) |
discount |
Number | Discount |
taxes |
Number | Taxes (Overrides _ctax ) |
shipping |
Number | Shipping (Overrides _cship ) |
item_total |
Number | Item total |
coupons |
String/Array | Coupons (Overrides _cpromo ) |
referrer_id |
String | Referrer ID |
items.quantity |
Array | Items quantity (Overrides _cquan ) |
items.priceSale |
Array | Items price sale (Overrides _cprice ) |
items.priceOrig |
Array | Items price original |
items.sku |
Array | Items SKU (Overrides _csku ) |
items.unit_price |
Array | Items unit price (Overrides _cprice ) |
items.name |
Array | Items name (Overrides _cprodname ) |
items.id |
Array | Items ID |
items.productId |
Array | Items product ID (Overrides _cprod ) |
items.orderItemId |
Array | Items order item ID |
items.mod |
Array | Items mod |
items.custom |
Array | Items custom |
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 information |
add_payment_info |
Add payment information |
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 |
---|---|---|
logged_in |
BooleanY or N |
Logged in |
category |
String | Category |
product_id |
String | Product ID |
price_sale |
Number | Price sale |
price_orig |
Number | Price orignal |
sku |
String | SKU |
search_term |
String | Search term |
name |
String | Name |
price |
Number | Price |
list_price |
Number | List price |
variant.color |
String | Variant color |
variant.brand |
String | Variant brand |
variant.size |
String | Variant size |
cart.quantity |
Array | Cart quantity |
cart.productId |
Array | Cart product ID |
cart.priceSale |
Array | Cart price sale |
cart.priceOrig |
Array | Cart price original |
cart.skuArray |
Array | Cart SKU (Overrides _csku ) |
cart.custom |
Array | Cart custom |
order_id |
String | Order ID |
order_total |
Number | Order total |
discount |
Number | Discount |
taxes |
Number | Taxes |
shipping |
Number | Shipping |
item_total |
Number | Item total |
coupons |
String/Array | Coupons |
referrer_id |
String | Referrer ID |
items.quantity |
Array | Items quantity |
items.priceSale |
Array | Items price sale |
items.priceOrig |
Array | Items price original |
items.sku |
Array | Items SKU |
items.unit_price |
Array | Items unit price |
items.name |
Array | Items name |
items.id |
Array | Items ID |
items.productId |
Array | Items product ID |
items.orderItemId |
Array | Items Order Item ID |
items.mod |
Array | Items mod |
items.custom |
Array | Items custom |
customerId |
String | Customer ID |
attrName |
String | Attribute name |
attrValue |
String | Attribute value |
widgetType |
String | Widget type |
widgetCallback |
Function | Widget callback |
Custom_Parameter |
Custom parameter |
This page was last updated: November 6, 2023