How to Set Up Web Tracking by Sending Events via Java Script Requests

To transfer website data to eSputnik, you need to install the web tracking script on your site. After, you’ll be able to send the user behavior data and use it to create personalized product recommendations for the site and for your emails.

You can send events through one of the methods:

Script

eS

Purpose

The script tracks what page a visitor is browsing and allows to send events from any page where it is installed.

Installation

The script should be installed on all pages of your site after the closing tag

<body>

It can be installed by using GTM but it can result in traffic loss as almost all content filters block GTM.

  • GTM (Google Tag Manager) is a tag management system that allows you to install user scripts on the site pages without interfering with its code.
  • Content filters (content-control software or web filtering software) is a tool or software that filters sites by content and blocks access to certain sites with content unavailable for viewing.

Example

<script>
!function(t, e, c, n) {
    var s = e.createElement(c);
    s.async = 1, s.src = 'https://statics.esputnik.com/scripts/' + n + '.js';
    var r = e.scripts[0];
    r.parentNode.insertBefore(s, r);
    var f = function() {
        f.c(arguments);
    };
    f.q = [];
    f.c = function() {
        f.q.push(arguments);
    };
    t['eS'] = t['eS'] || f;
}(window, document, 'script', '000000000000000000');
</script>
<script>
eS('init', {
    TRACKING: false,
    RECOMS: true
});
</script>

Parameters

Name Example Description
script

"00000000000000000"

Required

Type: string

Static parameter with a store's ID

TRACKING

true

Optional (true by default)

Type: boolean

When sending events via es.JS, the value should be set as false, while the automatic dispatch of the PageView event on page reload remains
RECOMS

true

Optional (true by default)

Type: boolean

Recommendation display through configuration (can work without TRACKING, but crawler config should be described)

 

Page View

PageView

Description

Sending the PageView event - occurs automatically when the page is reloaded, if you have a one-page site and when you go to other sections of the site, the page does not reload, you can configure the event transmission yourself.

Example

eS('sendEvent', 'PageView', {
    'PageView': {
        'user_email': 'example@email.com',
        'user_name': 'Johny',
        'user_client_id': '123',
        'user_card_id': '321',
        'user_phone': '3801111111111',
        'user_city': 'Gdańsk',
        'user_tags_gender': 'male',
    }
});

Site Visitor Data

In all events

Description

Sending events from all pages with a visitor ID (email, phoneNumber, contactId).

Necessary to match contacts with Cookies.

Example

{
	"GeneralInfo": {
		"user_email": "example@email.com",
		"user_phone": "380501234567",
		"user_es_contact_id": 100500
	},
	"ProductPage": {
		"productKey": "24-WG02"
	}
}

Parameters

Name Example Description
user_email

"example@email.com"

Optional

Type: string

Contact’s email
user_phone

"380501234567"

Optional

Type: string

Contact’s phone number
user_es_contact_id

"100500"

Optional

Type: int

With connected web push token collection, this contact identifier is located in the browser’s internal storage: Local Storage > esWebPushContactId

Product Card

ProductPage

Description

Sending a ProductPage event, a product card with availability, price and code of the product.

Necessary to calculate and display recommendations and send abandoned views.

Example

eS('sendEvent', 'ProductPage', {
        'ProductPage': {
            'productKey': '24-MB02',            
            'price': '153',
            'isInStock': 1,
            'tag_some_field': ['123'],
            'tag_another_field': ['321', '213']
        }});

If the item from the recommendations block is instantly added to cart on clicking Buy, you should send an additional ProductPage event.

If you need to send additional event parameters, use a different construction

Example
eS('sendEventWithTags', 'ProductPage', {
  "ProductPage": {
    "Product": {
      "productKey": "72354",
      "price": "754 USD",
      "isInStock": "1",
      "tag_something": [
        "abc",
        "bca"
      ]
    },
    "Tags": {
      "some_tags": [
        "some_tag1",
        "some_tag2"
      ]
    }
  }
});

Parameters

Name Example Description
productKey

“24-MB02”

Required

Type: string

  • Any product ID from the feed
  • Should match the productKey of the StatusCart event
price

“153”

Optional

Type: string

  • The price per item can be sent with the currency value
  • If the price has changed on the site but hasn’t changed in the feed, the sent value will be the value from the site
isinStock

“1”

Optional

Type: int

  • Indicates if items are in stock
  • Can have two values:

"0" – items are out of stock

"1" – items are in stock

  • If the availability has changed on the site but hasn’t changed in the feed, the sent value will be the value from the site
Tags

Optional

Type: object

Additional fields

Main Page

MainPage

Description

Sending the MainPage event.

Necessary to display recommendations on the site.

Example

eS('sendEvent', 'MainPage');

404 Page

NotFound

Description

Sending the NotFound event.

Necessary to display recommendations on the site.

Example

eS('sendEvent', 'NotFound');

Cart

StatusCart

Important!

The StatusCart event must be sent together with the PurchasedItems event. See the reason in the description of the GUID parameter below.

Description

The cart event is sent as an array of data. It should be sent on every cart page visit, cart page reload or cart page module display.

Changes should be sent from all pages (for example, product card or category page).

If there is an option to empty the cart, you need to send the empty cart event too.

Example (cart with added items)

eS('sendEvent', 'StatusCart', {
   'StatusCart': [
       {
           'productKey': '24-MB02',
           'price': '153',
           'quantity': '1',
           'currency': 'USD',
           "tag_something": [
               "aaa",
               "bbb"
           ]
       }, {
           'productKey': '123-321',
           'price': '450.00',
           'quantity': '3',
           'currency': 'USD'
       }
   ],
   'GUID': '2b914e9c-43ee-bf41-6f80-b97db1e8ab7e'
});

If you need to send additional event parameters, use a different construction

Example

eS('sendEventWithTags', 'StatusCart', {
  "StatusCart": {
    "GUID": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
    "Products": [
      {
        "productKey": "430738",
        "price": 201.95,
        "discount": 180,
        "quantity": 1,
        "price_currency_code": "UAH",
        "tag_something": [
          "aaa",
          "bbb"
        ]
      },
      {
        "productKey": "902339",
        "price": 596,
        "discount": 590,
        "quantity": 1,
        "price_currency_code": "UAH",
        "tag_something": [
          "aaa",
          "bbb"
        ]
      }
    ],
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
});

Example (empty cart)

eS('sendEvent', 'StatusCart', {
            'StatusCart': [],
            'GUID': '2c914e9c-43ee-bf41-6f80-b97db1e8ab7e'
        });

Parameters

Name Example Description
GUID

“2c914e9c-43ee-bf41-6f80-b97db1e8ab7e”

Required

Type: string

  • Unique ID that connects two events – StatusCart and PurchasedItems;
  • Should be identical to the GUID of the PurchasedItems event
  • Can be generated of random numbers and Latin characters
  • GUID is a link between the last cart and purchase
  • Should be unique for every cart status. It’s a 128-bit ID presented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens
productKey

“24-MB02”

Required

Type: string

  • Any product ID from the feed
  • Should match the productKey of the ProductPage event

price

“153”

Required

Type: string

The price per item can be sent with the currency value
quantity

“5”

Required

Type: string

Quantity of items
currency

“USD"

Optional

Type: string

Currency
tags

Optional

Type: object

Additional fields

Purchase

PurchasedItems

Description

To show recommendations on the order confirmation page or to send abandoned cart triggers, you need to send a request specifying the purchased item.

If you don’t send abandoned cart triggers, you can send the items in the PurchasedItems event, without StatusCart.

Example (purchase in one click)

eS('sendEvent', 'PurchasedItems', {
    "OrderNumber": "123/2017",
    "PurchasedItems": [{
        "productKey": "24-MB02",
        "price": "153",
        "quantity": "1",
        "currency": "USD"
    }],
    "Tags": {
        "blockId": ["19787_r119v224"]
    }
});

If you need to send additional event parameters, use a different construction

Example

eS('sendEventWithTags', 'PurchasedItems', {
  "PurchasedItems": {
    "Products": [
      {
        "product_id": "430738",
        "unit_price": "201.95",
        "quantity": 1
      },
      {
        "product_id": "211452",
        "unit_price": "341.80",
        "quantity": 2
      }
    ],
    "OrderNumber": "123/2017",
    "Tags": {
      "block_id": [
        "21246_r335v507"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
});

Example (purchase from the site)

eS('sendEvent', 'PurchasedItems', {
    "OrderNumber": "123/2017",
    "PurchasedItems": [{
        "productKey": "24-MB02",
        "price": "153",
        "quantity": "1",
        "currency": "USD"
    }],
"GUID": "6F9619FF-8B86-D011-B42D-00CF4FC964FF"
});

If you need to send additional event parameters, use a different construction

Example
eS('sendEventWithTags', 'PurchasedItems', {
  "PurchasedItems": {
    "GUID": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
    "OrderNumber": "123/2017",
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
});

Parameters

Name Example Description
OrderNumber

"1234/2017"

Required

Type: string

Order number
GUID

"6F9619FF-8B86-D011-B42D-00CF4FC964FF”

Required

Type: string

  • Unique ID that connects two events – StatusCart and PurchasedItems
  • Should be identical to the GUID of the PurchasedItems event
  • Can be generated of random numbers and Latin characters
  • GUID is a link between the last cart and purchase
  • Should be unique for every cart status. It’s a 128-bit ID presented as 32 hexadecimal (base-16) digits, displayed in five groups separated by hyphens
productKey

Required

Type: string

  • Any product ID from the feed
  • Should match the productkey of the ProductPage event
price

"21.70"

Required

Type: string

The price per item can be sent with the currency value
quantity

“1”

Required

Type: string

Quantity of items
currency

“USD"

Optional

Type: string

Currency
tags

Optional

Type: object

Additional fields
blockID

Optional

Type: string

  • Taken from the URL line sc_content=
  • If there is no parameter query in the URL, blockID and its value aren’t sent.=
  •  

Customer

CustomerData

Description

To send abandoned cart and abandoned browse triggers, you need to send a request with the customer data. Apart from abandoned cart and abandoned browse emails, it can be used in order confirmations and registration confirmations.

Example

eS('sendEvent', 'CustomerData', {
    'CustomerData': {
        'user_email': 'example@email.com',
        'user_name': 'Johny',
        'user_client_id': '123',
        'user_card_id': '321',
        'user_phone': '3801111111111',
        'user_city': 'Gdańsk',
        'user_tags_gender': 'male',
    }
});

Parameters

Name Example Description
user_email

"example@email.com"

Required

Type: string

User’s email is necessary to send abandoned carts and browses
user_name

"John”

Optional

Type: string

User name
user_client_id

“123”

Optional

Type: string

User ID
user_card_id

"321"

Optional

Type: string

User card ID
user_phone

"3801111111111"

Required

Type: string

Phone number in the international format

Category

CategoryPage

Description

To show recommendations on the category page, you need to send a request specifying what category the user is viewing.

Example

eS('sendEvent', 'CategoryPage', {
    "CategoryPage": {
        "categoryKey": "Babies"
    },
    "Tags": {
        "some_tags": [
            "gh",
            "a2"
        ],
        "some_tags1": [
            "4",
            "gg"
        ]
    }
});

If you need to send additional event parameters, use a different construction

Example
eS('sendEventWithTags', 'CategoryPage', {
  "CategoryPage": {
    "Category": {
      "categoryKey": "Для малышей"
    },
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
});

Parameters

Name Example Description
CategoryPage

“Babies"

Required

Type: string

  • Category ID
  • Can be a category name or any other ID available in the feed
Tags

Optional

Type: object

Additional fields

Impressions

ProductImpression DEPRECATED

Description

To show impressions for recommendation blocks in Reports, you need to send a request with data on the displayed items.

Example

eS('sendEvent', 'ProductImpressions', {
    "ProductImpression": [{
        "product_id": "430968",
        "container_type": "1253"
    }]
});

If you need to send additional event parameters, use a different construction

Example
eS('sendEventWithTags', 'ProductImpression', {
  "ProductImpression": {
    "Products": [
      {
        "product_id": "430968",
        "container_type": "1253"
      },
      {
        "product_id": "430738",
        "container_type": "1254"
      },
      {
        "product_id": "429983",
        "container_type": "1255"
      }
    ],
    "Tags": {
      "some_tags": [
        "1",
        "a2"
      ],
      "some_tags1": [
        "4",
        "gg"
      ]
    }
  }
});

Parameters

Name Example Description
product_id

“PK1"

Required

Type: string

ID of the displayed item
container_type

“1253”

Required

Type: string

Recommendation block number
Tags

Optional

Type: object

Additional fields

If there are several blocks on one page, all sessions are sent in one request.

Any Questions?
We’re always happy to help!
Request a Callback
Fill in the form, and our specialists will call you back as soon as possible.
Request a Callback
Chat Support
We’re waiting for your questions!
Send a Chat Message
Email
Contact the eSputnik support team
Send an Email