StatusSupport
Developers
Tweakwise.comTweakwise AppContact
Start typing to search…

Events & parameters

Events

What, when and how to send the signals.

Session start

Necessary to establish a baseline, for example for a/b testing.

Notes:

  • Event Tag client-side: this will work automatically.
  • Shopify: this will work automatically.
  • Shopware plugin: this will work automatically.

Page impressions

Send the signal when displaying a lister page, search result page, recommendations or guided selling.

Implementation specific:

  • Tweakwise JS: this will work automatically.
  • Shopify: this will work automatically.
  • Shopware plugin: this will work automatically.

Item clicks

Send the click on lister pages, search result pages and recommendations.

Implementation specific:

  • Tweakwise JS: this will work automatically.
  • Shopify: this will work automatically.
  • Shopware plugin: this will work automatically.

Search phrases

Send the searchterm on search result pages.

Note: do not send for suggestions. This will pollute the reports with unfinished terms.

Implementation specific:

  • Tweakwise JS: this will work automatically.
  • Shopify: this will work automatically.
  • Shopware plugin: this will work automatically.

Product views

When viewing a item, for example the product detail page or product quickview.

Implementation specific:

  • Shopify: add this to Customer Events, specifically product_viewed. See Event Tag - Shopify.
  • Shopware plugin: this will work automatically.

Add to cart

Send when a product is added to the cart.

Implementation specific:

  • Tweakwise JS: only send this in the places we don't control. For example on the product detail page.
  • Shopify: add this to Customer Events, specifically product_added_to_cart. See Event Tag - Shopify.
  • Shopware plugin: this will work automatically.

Add to wishlist

Send when a product is added to a wishlist/favorited.

Implementation specific:

  • Tweakwise JS: only do this in the places we don't control. For example on the product detail page.
  • Shopify: add this to Customer Events with a custom event that hooks into the wishlist plugin.
  • Shopware plugin: this will work automatically.

Purchases

When a conversion is done (order is placed). Send the signal.

Implementation specific:

  • Shopify: add this to Customer Events, specifically checkout_completed. See Event Tag - Shopify.
  • Shopware plugin: this will work automatically.

Frequently Asked Questions



ProfileKey

Customer identification is done through a profile key. This is our way to identify your customers using a unique identifier.

You can determine the profile key yourself. Generally account id's are used for logged-in users and visitor-id's for anonymous users.

Format

The profile key should be a string that only contains alphanumeric characters. Accepted characters: A-Z a-z 0-9

If no profile key is supplied, our Tweakwise Analytics JS will generate a unique identifier for the current user.

🚧

Warning

The use of personal information such as email addresses, phone numbers, or other personal information as profile keys is not permitted in order to comply with GDPR guidelines.

Only use anonymized data such as ID numbers or hashed values. By following the GDPR guidelines, you meet the requirements for the protection of users and data.


requestId

Every API request returns a unique request identifier that can be passed to these e-commerce events. In the background, we store the event information and request relation. This enables us to analyze the configuration of builder, filter templates, algorithms and give Actionable Insights.

The request identifier is sent in the response headers:

curl --request GET \
     --url https://gateway.tweakwisenavigator.com/navigation/{instancekey} \
     --header 'accept: text/xml'

Would result in a response header that resembled:

Twn-Request-Id: cae158c4107789408a7ac8f0eedc57a3

You can use this requestId to send with all the events that require the requestId.

💡

Using Google Tag Manager?

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.