Setting Up Engagement Attributes

Engagement Attributes:

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.

Data structure:

Products Object:

Product Object:

Cart update SDE JSON example:

{
  "type": "cart", //MANDATORY
  "total": 11.7, //TOTAL CART VALUE
  "currency": "USD", //CURRENCY CODE
  "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
  }]
}

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:

Cart Object

Transaction SDE JSON example:

{
  "type": "purchase", //MANDATORY
  "total": 11.7, //TOTAL VALUE OF THE TRANSACTION AFTER DISCOUNT
  "currency": "USD", //CURRENCY CODE
  "orderId": "DRV1534XC", //UNIQUE ORDER ID OR RECEIPT ID
  "cart":{
      "products": [{
            "product": {
              "name": "antivirus pro plan", //PRODUCT NAME
              "category": "software", //PRODUCT CATEGORY NAME
              "sku": "xyz001", //PRODUCT SKU OR UNIQUE IDENTIFIER
              "price": 7.8 //SINGLE PRODUCT PRICE
            },
      "quantity": 3 //QUANTITY OF THIS PRODUCT
      }]
    }
}

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:

Viewed Product SDE JSON example:

{
    "type": "prodView", //MANDATORY
    "currency": "USD", //CURRENCY CODE
    "products": [{ //ARRAY OF PRODUCTS
        "product": {
            "name": "red high heel shoe", //PRODUCT NAME
            "category": "women shoes", //PRODUCT CATEGORY NAME
            "sku": "xyz567", //PRODUCT SKU OR UNIQUE IDENTIFIER
            "price": 77.8 //SINGLE PRODUCT PRICE
        }
    }]
}

Visitor Info

Visitor Info Engagement Attributes allow you to collect more information about your visitors, including where they came from, and the affiliates they are associated with.

Customer Info

This Engagement Attribute is used to collect information about a registered visitor such as the customer type (for example, VIP or Platinum), and their unique identifier.

This information can be used to segment visitors and tailor an experience based on their attributes (customer type, status, and balance). For example, you can invite your most valuable customers to chat with your relevant agents, while offering self-service content to low-tier customers.

Please note - storeZipCode and storeNumber ARE NOT supported in an authenticated flow!

Customer info SDE JSON example:

{
    "type": "ctmrinfo", //MANDATORY
    "info": {
    10
    ENGAGEMENT ATTRIBUTES OVERVIEW
    "cstatus": "cancelled", //CUSTOMER LIFECYCLE STATUS. FROM PRE-DEFINED LIST
    "ctype": "vip", //CUSTOMER TYPE OR TIER. FROM PRE-DEFINED LIST
    "customerId": "138766AC", //UNIQUE CUSTOMER IDENTIFIER
    "balance": -400.99, //THE CUSTOMER FINANCIAL BALANCE IN DECIMAL VALUE
    "currency": "USD", //CURRENCY CODE
    "socialId": "11256324780", //SOCIAL ID OF YOUR CHOICE: FACEBOOK, TWITTER
    ETC...
    "imei": "3543546543545688", //UNIQUE DEVICE OR PHONE IDENTIFIER
    "userName": "user000", //CONSUMER NICKNAME OR USERNAME
    "companySize": 500, //COMPANY SIZE MEASURED BY NUMBER OF EMPLOYEES
    "accountName": "bank corp", //THE CUSTOMER'S COMPANY NAME
    "role": "broker", //CONSUMER ROLE TITLE
    "lastPaymentDate": {
      "day": 15, //THE DAY OF THE LAST PAYMENT NUMERIC VALUE
      "month": 10, //THE MONTH OF THE LAST PAYMENT NUMERIC VALUE
      "year": 2014 //THE YEAR OF THE LAST PAYMENT NUMERIC VALUE
    },
    "registrationDate": {
      "day": 23, //THE DAY OF THE REGISTRATION NUMERIC VALUE
      "month": 5, //THE MONTH OF THE REGISTRATION NUMERIC VALUE
      "year": 2013 //THE YEAR OF THE REGISTRATION NUMERIC VALUE
    },
    "storeNumber": "123865", //STORE NUMBER
    "storeZipCode": "20505" //STORE ZIP CODE
  }
}

Marketing source

This Engagement Attribute is used to obtain more information about the marketing source of your visitors, which channel or campaign drove visitors to your website, and with which affiliates they are associated.

This information can be used to segment visitors and tailor an experience based on the traffic source (originating channel, campaign or affiliate). For example, you can display a specific offer to visitors that arrived to the website through a specific affiliate, or route a visitor to a relevant agent based on the originating channel.

Data structure:

Info object:

Marketing source SDE JSON example:

{
  "type": "mrktInfo", //MANDATORY
    "info": {
      "channel": "1", //ORIGINATING CHANNEL ENUM:
      "affiliate": "Yahoo", //AFFILIATE NAME
      "campaignId": "US coupon campaign" //EXTERNAL ORIGINATING CAMPAIGN
  }
}

Personal info

This Engagement Attribute is used to collect personal information about your visitors. You can pass login information from cookies, or from questions you ask them in your forms.

This information can be used to segment visitors and tailor an experience based on their attributes (age and gender). For example, you can exclude visitors that are too young for your service/product, or display different wording or offers based on the visitor’s gender.

Data structure:

Age object:

Contact object:

Personal info SDE JSON example:

{
    "type": "personal", //MANDATORY
      "personal": {
        "firstname": "John", // FIRST NAME
        "lastname": "Doe", // SURNAME
      "age": {
          "age": 34, // AGE AS INTEGER
          "year": 1980, // BIRTH YEAR
          "month": 4, // BIRTH MONTH
          "day": 15 // BIRTH DAY
        },
      "contacts": [{
        "email": "myname@example.com", // EMAIL
        "phone": "+1 212-788-8877" // PHONE NUMBER
      }],
      "gender": "MALE", // MALE, FEMALE, OTHER
      "language": "en-US", // LANGUAGE
      "company": "company" // VISITOR COMPANY NAME
    }
}

Visitor Journey

Visitor Journey Engagement Attributes allow you to collect information about key actions that visitors take along their journey, and customize their experience accordingly. This includes the leads they generated, errors they experienced, and more.

Lead

This Engagement Attribute is used to track lead information that can help you identify what your visitors are interested in, and where they are in your funnel. This information can be used to track conversions. The lead value will also appear in your revenue reports as a means to measure the monetary value of your campaigns. A session can have more than a single lead in it, and can be connected to a single ticket ID or multiple tickets.

Data Structure:

Lead object:

Lead SDE JSON example:

{
  "type": "lead", //MANDATORY
    "lead": {
      "topic": "luxury car test drive 2015", //TOPIC OR NAME OF A SUBMITTED LEAD
      "value": 22.22, //EVALUATED VALUE OF THE LEAD
      "currency": "USD", //CURRENCY CODE
      "leadId": "xyz123" //LEAD IDENTIFIER OR TICKET ID
  }
}

Service activity

This Engagement Attribute is used to measure service activities, for example, ordering a checkbook, submitting an application, or requesting a mortgage.

This information can be used to track conversions, for example, a visitor that completed a loan application. It can additionally be used to follow up with visitors, for example, engaging with a visitor whose application has been canceled. A session can have more than one service activity in it.

Data structure:

Service object:

Service Activity SDE JSON example:

{
  "type": "service", //MANDATORY
  "service": {
    "topic": "order checkbook", // SERVICE ACTIVITY TOPIC OR NAME
    "status": 0, // STATUS ENUM
    "category": "finance", // SERVICE CATEGORY NAME
    "serviceId": "service12" // SERVICE UNIQUE IDENTIFIER OR TICKET ID
  }
}

Visitor error

This Engagement Attribute is used to collect information about errors that visitors experience when they browse the website and fill out forms. All errors are aggregated in a list during the session until resolved.

This information can be used to offer help to visitors who are struggling to complete a specific action.

Data Structure:

Error object:

Visitor Error SDE JSON example:

{
  "type": "error", //MANDATORY
  "error": {
    "contextId": "Credit card application",
    "message": "Expiration date missing", // ERROR MESSAGE
    "code": "er100004", // ERROR CODE
    "level": 10,
    "resolved": false
  }
}

Searched content

Note: This SDE cannot be reported from Mobile due to internal server limitations.

This Engagement Attribute is used to report on content that was searched by consumers on the brand’s website such as FAQ and different articles or products.

This information can be used to offer help to visitors based on their searches.

Data structure:

Searched content SDE JSON example:

{
  "type": "searchInfo", //MANDATORY
  "keywords": ["Reset password"], //TERMS SEARCHED BY A VISITOR. FOR EXAMPLE: FAQ
  ABOUT RESET PASSWORD
}

Section

This Engagement Attribute is used to determine the appropriate Location for engaging with visitors or to display where the visitors are browsing.

Code example:

lpTag.section = [ //SET A LIST OF YOUR SITE SECTIONS
"electronics", //CAN BE A SECTION OR A SUB-SECTION
"user agreement faqs"
];