BigCommerce Event Tracking Code

Hawksearch requires tracking information for report generation and Recommendation features to function. The events are of multiple kinds such as visits, searches, clicks, purchases and many others. Hawksearch provides some events automatically however events such as Add to Cart and Sale need to be sent to Hawksearch from the website explicitly upon user action. For any additional questions please reach out support@hawksearch.com. The remainder of the article details the tracking feature for Big Commerce connector.

The APP does not install the tracking code for implementing all of the advanced reporting supported by Hawksearch. The keyword and autocomplete reports will be populated based on the search keywords on the search results page and autocomplete requests. For cart addition, sale and personalization features, please implement Event tracking specified in the following sections.

For Hawksearch v4.0 (latest):

To integrate through API - Events Tracking API Integration.
To integrate through Rapid UI Framework: TrackingService | @bridgeline-digital/hawksearch-handlebars-ui

For Hawksearch v2.0L to v4.0L:

This section is only applicable for Hawksearch v2.0L-4.0L implementations with JavaScript integration.

Please contact your Project Manager if you are unsure of the tracking implementation or version.

In \templates\layout\base.html and \templates\layout\empty.html place the following code before the </body> tag:

<script type="text/javascript"> 
        HawkSearch.customEvent = function() {
        //<![CDATA[
             if ('{{template}}') {
                  if (('{{template}}' == 'pages/category') || ('{{template}}' == 'pages/custom/category/category') || ('{{template}}' == 'pages/search')) { 
                       HawkSearch.Tracking.track('pageload', {pageType: 'landing'}); } else if ('{{template}}' == 'pages/product') { 
                       HawkSearch.Tracking.track('pageload', {pageType: 'item'}); 
                       HawkSearch.Context.add("UniqueId", "{{product.id}}"); } else if ('{{template}}' == 'pages/cart') { 
                       HawkSearch.Tracking.track('pageload', {pageType: 'cart'}); } else { 
                       HawkSearch.Tracking.track('pageload', {pageType: 'custom'});
              }
        } //]]>
     } 
</script>

In \templates\layout\base.html and \templates\layout\empty.html place the following code before the </body> tag:

<script type="text/javascript"> 
  HawkSearch.customEvent = function() { 
    //<![CDATA[ if ('{{template}}') { 
    if (('{{template}}' == 'pages/category') || ('{{template}}' == 'pages/custom/category/category') || ('{{template}}' == 'pages/search')) { 
      HawkSearch.Tracking.track('pageload', {pageType: 'landing'}); 
    } 
    else if ('{{template}}' == 'pages/product') { 
      HawkSearch.Tracking.track('pageload', {pageType: 'item'}); 
      HawkSearch.Context.add("UniqueId", "{{product.id}}"); 
    } 
    else if ('{{template}}' == 'pages/cart') { 
      HawkSearch.Tracking.track('pageload', {pageType: 'cart'}); 
    } 
    else { 
        HawkSearch.Tracking.track('pageload', {pageType: 'custom'}); 
      } 
    } //]]> 
  } 
</script>

In \templates\pages\order-confirmation.html place the following code before {{/partial}}

<script type="text/javascript">
    HawkSearch.customEvent = function() {
        HawkSearch.Tracking.track('pageload', {pageType: 'order'});
    }
 
    var orderNum = '{{checkout.order.id}}';
    console.log('orderNo = ' + orderNum);
    if (orderNum) {
        var xhttp = new XMLHttpRequest();
        xhttp.onreadystatechange = function() {
            if (this.readyState == 4 && this.status == 200) {
                if (this.responseText) {
                    var response = JSON.parse(this.responseText);
                    var itemList = [];
 
                    for (var i = 0; i < response.lineItems.physicalItems.length; i++) {
                        var item = response.lineItems.physicalItems[i];
                        itemList.push({
                            uniqueid: item.productId,
                            itemPrice: item.listPrice,
                            quantity: item.quantity
                        });
                    }
 
                    var hsObject = {
                        orderNo: orderNum,
                        itemList: itemList,
                        total: response.orderAmount,
                        subTotal: response.baseAmount,
                        tax: response.taxes[0].amount,
                        currency: response.currency.code
                    };
 
                    HawkSearch.customEvent = function() {
                        HawkSearch.Tracking.track('sale', hsObject);
                    }
                }
            }
        };
        xhttp.open('GET', '/api/storefront/orders/' + orderNum, true);
        xhttp.send();
    }
</script>

^Note:^{this code only takes physical items into account, if digital items or gift certificates are sold the code will need to be adjusted to take that data point into account (order api can be found here:}https://developer.bigcommerce.com/api-reference/storefront/orders/order/ordersbyorderidget ^).

In \templates\components\products\add-to-cart.html find the <input> tag with an id of "form-action-addToCart" and add and attribute of data-pid with a value of {{product.id}}, so the element should look similar to:

^{<input id="form-action-addToCart" data-wait-message="lang 'products.adding_to_cart'" data-pid="product.id" class="button button--primary" type="submit" value="#if product.pre_orderlang 'products.pre_order'elselang 'products.add_to_cart'/if">}

In \assets\js\theme\common\product-details.js within the addProductToCart function call look for the utils.api.cart.itemAdd api call and add the following: