eCommerce info Engagement Attributes allow you to track eCommerce-related activities on your website.
Cart update
This Engagement Attribute is used to get the status of the visitor’s shopping cart. The cart status includes the product items within the cart and its total monetary value.
The cart value and/or the products in the cart can be used to target visitors. For example, you can target low value shoppers and encourage them to buy more in order to get your free shipping coupon. You can also offer complementary products in addition to products in the cart.
Name | Description | Type | Value/Example | Mandatory |
type |
The event name ("cart") |
double | 11.7 | true |
total | Total cart value | string | "cart" | true |
currency | Currency of the total cart value | string | USD | false |
numItems | Number of items in cart | integer | 6 | true |
products | Array of items in cart | Array of Products objects | [{ "product": {...}, "quantity": 2 }, { "product": {...}, "quantity": 1 }] | false |
Cart update SDE JSON example:
{ "type": "cart", //MANDATORY "total: 11.7, //TOTAL CART VALUE "numItems": 6, //NUMBER OF ITEMS IN CART "products": [{ //ARRAY OF PRODUCTS "product": { "name": "prod1", //PRODUCT NAME "category": "category", //PRODUCT CATEGORY NAME "sku": "sku", //PRODUCT SKU OR UNIQUE IDENTIFIER "price": 7.8 //PRODUC PRICE }, "quantity": 1 //NUMBER OF PRODUCTS }] }
Transaction
This Engagement Attribute is used to track any money transaction, purchase of items, or deposit, including the items themselves and their details.
The total transaction value can be used to track conversions. It is also displayed in your revenue reports as a means of measuring the monetary value of your campaigns.
Data structure:
Name | Description | Type | Value/Example | Mandatory |
type |
The event name ("cart") |
string | "purchase" | true |
total | Total transaction value | double | 11.7 | false |
currency | Currency of the total transaction value | string | USD | false |
orderId | Unique order or receipt ID | string | "orderId123" | false |
cart | Cart details | Cart object | [{ "numItems": 6, "products": [{...}, {...}] }] | false |
Name | Description | Type | Value/Example | Mandatory |
Products |
Arra of Items in cart |
Array of Products objects | [{ "product": {...}, "quantity": 2 }, { "product": {...}, "quantity": 1 }] | false |
numItems | Number of items in a cart | integer | 6 | false |
Transaction SDE JSON example:
{ "type": "cart", //MANDATORY "total": 11.7, //TOTAL CART VALUE "numItems": 6, //NUMBER OF ITEMS IN CART "products": [{ //ARRAY OF PRODUCTS "product": { "name": "prod1", //PRODUCT NAME "category": "category", //PRODUCT CATEGORY NAME "sku": "sku", // PRODUCT SKU OR UNIQUE IDENTIFIER "price": 7.8, //PRODUCT PRICE }, "quantity": 1 // NUMBER OF PRODUCTS }] }
Viewed product
This Engagement Attribute is used to track a product or service that interests visitors. Each product is described by Name, Category, and SKU.
This information can be used to target visitors. For example, you can offer products to visitors which are in the same category or price range as the products they previously viewed.
Data structure:
Name | Description | Type | Value/Example | Mandatory |
type |
The event name ("prodView") |
String | "prodView" | true |
currency | Currency of the viewed products | string | USD | false |
products | Array of Items in cart | array of Products objects | [{ "product": {...}, "quantity": 2 }, { "product": {...}, "quantity": 1 }] | false |
{ "type": "prodView", //MANDATORY "products": [{ //ARRAY OF PRODUCTS "product": { "name": "red hight heel shoe", //PRODUCT NAME "category": "womens shoes", //PRODUCT CATEGORY NAME "sku": "xyz567", //PRODUCT SKU OR UNIQUE IDENTIFIER "price": 77.8 //PRODUCT PRICE } }] }