To analyze the performance of your configuration, power our insights reports and support personalization, we capture key e-commerce events on your platform. These are events such as product views, item clicks, add-to-carts, and purchases.

To get more insights, follow these steps:

Install the snippet
Track:
- item clicks on category pages, search results, suggestions and recommendations.
- search phrases on search results pages
- product views when viewing a product (detail page)
- purchases when a conversion is logged (order is placed)

Looking for a server-to-server option? Check out Event Tag - Server-to-server.

Installation

The Insights Tag is a lightweight javascript SDK to capture key e-commerce events on your platform. To make use of essentials or personalization, implement the following snippet on the frontend of your platform:

 <script>
    (function(w, d, l, i, u) {
      w['_twa'] = l;
      w[l] = w[l] || [];
      w[l].push({ 'twa.start': new Date().getTime(), event: 'twa.js' });
      w[l].push({ 'twa.instance': i, event: 'twa.init' });
      var f = d.getElementsByTagName('script')[0],
          j = d.createElement('script');
      j.async = true;
      j.src = u;
      f.parentNode.insertBefore(j, f);
    })(window, document, 'tweakwiseLayer', '{instancekey}', "//navigator-analytics.tweakwise.com/bundles/scout.js");
    </script>

Notes:

Replace {instancekey} with your instance key. You can find the key on your app dashboard.

🚧
CSP
If you implemented a Content Security Policy, make sure navigator-analytics.tweakwise.com is added to the allowed domains list.

Custom profilekey

In some cases, you might want to determine the profile key yourself. For example if you want to support cross-device personalization. In these cases is is recommended to use the currently authenticated user.

Replace the default snippet with:

 <script>
    var profileKey = '{profilekey}';

    (function(w, d, l, i, p, u) {

      w['_twa'] = l;
      w[l] = w[l] || [];
      w[l].push({ 'twa.start': new Date().getTime(), event: 'twa.js' });
      w[l].push({ 'twa.instance': i, event: 'twa.init' });
      
      p && w[l].push({ 'twa.profile': p, event: 'twa.profile' });
  		if(p){ w[l].getProfileKey = function(){ return p; } }

      var f = d.getElementsByTagName('script')[0],
          j = d.createElement('script');
      j.async = true;
      j.src = u;
      f.parentNode.insertBefore(j, f);

    })(window, document, 'tweakwiseLayer', '{instancekey}', profileKey, "//navigator-analytics.tweakwise.com/bundles/scout.js");
    </script>

Replace {instancekey} with your instance key. You can find the key on your app dashboard.
Replace {profilekey} with a reference to the current customer/visitor.

Events

To analyze the performance of your configuration and power some of our insights reports, we gather information from key requests.

Search

To measure the amount of search queries, send a search event when the search results page. I is displayed user enters a search term, including the term the user has entered.

Property	Value / description
profileKey	The profile key identifying the visitor. Accepted characters: letters (A-Z, a-z), numbers (0-9), and dashes (-)
searchTerm	The search term the visitor used to search for products.

tweakwiseLayer.push({
  event: 'search',
	data: {
		profileKey: profileKey,
		searchTerm: 'Jeans'
  }
});

Click product

To measure how many times an item is clicked, send a itemClick event whenever a user clicks/taps an item. It is crucial for analyzing the performance of builder components.

Property	Required	Value / description
itemId	yes	The unique id of the item
requestId	yes	The id of the linked Tweakwise request. See About requestid.

tweakwiseLayer.push({
	event: 'itemClick',
	data: {
		itemId: 'item-id-123',
		requestId: '45fdf-a5401-845d5-596b7-99226-14a43-5bcf'
	}
});

<template>
  <div v-for="product in navigation.items" class="group" @click="onProductClick">
    <a :href="product.href" class="aspect-square w-full bg-gray-100">
      <img :src="product.image" class="aspect-square object-cover" />
    </a>
    <h3 class="mt-4 font-bold"><a :href="product.href">{{ product.title }}</a></h3>
    <p>{{ $n(product.price, 'currency') }}</p>
  </div>
</template>

<script lang="ts" setup>
let url = `https://gateway.tweakwisenavigator.com/navigation/${instanceKey}/?tn_cid=${cid}&format=json`;

const { data, error } = await useAsyncData('category:' + cid, async () => {  
  const response = await $fetch.raw(url, { responseType: 'json' });  
  
  // save requestid to pass on to client
  const requestId = response.headers.get('twn-request-id');
  
  return { navigation: response._data, requestId };
})

function onProductClick() {
    window['tweakwiseLayer'].push({
        event: 'itemClick',
        data: {
            itemId: product.itemno,
            requestId: requestId
        }
    })
}
</script>

Notes:

Using Tweakwise JS? This will work out of the box!
This is only available if a response contains a requestId. To learn more, go to About requestid.
When implementing the Tweakwise event tag in Google Tag Manager (GTM), you need to store the requestId from the Tweakwise navigation-search response and pass it to the dataLayer. This allows you to use the requestId in your GTM tags and triggers.

View product

To measure how many times item details are viewed, send a productView event whenever a user views an item’s details screen.

Property	Required	Value / description
profileKey	yes	The profile key identifying the visitor. Accepted characters: letters (A-Z, a-z), numbers (0-9), and dashes (-)
productKey	yes	The unique id of the item

tweakwiseLayer.push({
	event: 'productView',
	data: {
		profileKey: profileKey,
		productKey: 'ARTICLENUMBER1'
	}
});

Purchase

The purchase event tracks the transaction of your customers. It is crucial for analyzing the performance of A/B tests, builder, filter templates and more.

Property	Value / description
profileKey	The profile key identifying the visitor. Accepted characters: letters (A-Z, a-z), numbers (0-9), and dashes (-)
productKeys	Array of unique id's of the items in the transaction
revenue	The total revenue from the purchase, calculated as the sum of product prices after discounts have been applied and before taxes are added. Can be empty, or must contain a value greater than or equal to 0.

tweakwiseLayer.push({
	event: 'purchase',
	data: {
		profileKey: profileKey,
		productKeys: ['ARTICLENUMBER1', 'ARTICLENUMBER2', 'ARTICLENUMBER3'],
    revenue: 124.50
	}
});