Verify Click Tracking Integration¶

Warning: This guide only pertains to Recommendation, Search, or Pages integrations, built through the SDK or REST API.

Purpose and expectations¶

This guide assumes that you have completed one of the Hello Retail product solution integrations and are now looking to verify that you have configured Hello Retail click tracking correctly.

If you are looking for a guide on how to configure Hello Retail click tracking from scratch, see this guide

Understanding the Hello Retail click tracking fragment¶

As part of the Hello Retail click tracking fragment, you will find that the fragment is always prefixed with two letters:

• pb: A tracking fragment originating from a managed Hello Retail Recommendation solution.
• ur: A tracking fragment originating from an unmanaged Hello Retail Recommendation solution.
• ps: A tracking fragment originating from a Hello Retail Search solution.
• pa: A tracking fragment originating from a Hello Retail Pages solution.

Correctly utilizing the Hello Retail click tracking fragment¶

• The click tracking fragment is a unique per-product property and should never be reused.
• The click tracking fragment is generated and returned as part of the product data response for whichever Hello Retail product solution you requested. This occurs every time you request a Hello Retail product solution.
  Do not store a generated fragment for later reuse on the same product.

Referencing the Hello Retail API log¶

The Hello Retail API log can be referenced to verify whether the intended Hello Retail dashboard environment received the produced click tracking event.

Read more about using the API log here

Once familiar with the API log, proceed to the steps below to verify your click tracking integration.

Hello Retail click tracking verification steps¶

1. Enable logging in the Hello Retail API log for the desired dashboard environment.
2. Use the API endpoint filters dropdown and select collect/click: POST.
3. Navigate to the frontend environment where you have configured a Hello Retail product solution with click tracking, and click a product.
4. Return to the Hello Retail API log and refresh.
5. If your click tracking integration works, you should see a request appear in the left-hand side.
6. If no request appears after clicking a product on your frontend, verify that you are communicating with the correct Hello Retail dashboard environment websiteUuid.
   If the websiteUuid is correct and you still see no request, then Hello Retail never received your request and you should investigate the cause on your end.
7. Once a click tracking request is visible and recognized in the API log, select the request by clicking the request bar in the left-hand panel.
8. Clicking the produced request bar will populate the right-hand side with details about the request. Ensure the following:
   • Only one request per click is produced. Accidentally producing more than one click tracking request per actual click will prevent Hello Retail from effectively gathering click tracking analytics.
   • A trackingUserId is supplied as part of the request, assuming the visiting customer has opted in to tracking.
     • Opt-in/-out of tracking documentation
     • Tracking user documentation
   • The source values are different between different products in your configured Hello Retail product solution on the frontend. Validate by clicking different products.
   • You test the click tracking integration at least once for each Hello Retail product solution integration on the frontend.