For Tag Rocket to accurately track product cards on Product Listing Pages (PLP’s), we need them to have their product ID embedded within the HTML. If you’re using Cornerstone (v6.12.0 or newer) theme with standard search then this data already exists and there’s no issues. Many BigCommerce stores however use custom themes or 3rd party search providers that either do not replicate the standard behaviour. This article explains how to identify issues and the steps to resolve such tracking challenges.
On This Page:
Standard Data Attributes
The below image highlights the important data attributes Tag Rocket requires on all product lists in order to track comprehensively. They are:
- data-entity-id: The BigCommerce product ID for the card
- data-event-type: For the purposes of this article, this will always be “list” to signify a product within a list
- data-list-name (optional): The name of the product list – eg, “Featured Products“, “Search Results” or “Category: Kitchen“. If this attribute does not exist, the name of the page is used.
- data-position (optional): The position of the product in the list, eg first card is “1”
The below image highlights the important data attributes Tag Rocket requires on all product lists in order to track comprehensively. They are:
Search Provider Attributes
If you use a custom search provider anywhere on your pages to deliver product cards for search or faceted navigation, they may be providing these data attributes but usually in a different format. We’ve been working hard to determine the formats most commonly used and provide a translation service within Tag Rocket. Simply choose your search provider under Global Tag Values -> Search Provider and choose between the following supported providers.
- Algolia
- Convermax
- Doo Finder
- Fast Simon
- FreshClick
- Hawk Search
- Klevu
- Searchanise
- Search Magic
- Search Spring
Checking For Attributes
There are a number of page types to check for these attributes – commonly:
- Home page (“Featured”, “Best Seller” lists etc.)
- Search Page (as image above)
- Category/Brand Pages
- Product Page (“Related Products” etc)
Product Card Tracking Visualisation
To make it easier for you to quickly identify whether product cards are tracked correctly, we have built a feature into Tag Rocket that visualises the tracking for you. Simply enable the Global Tag Values -> Show Show Events Debug Mode option within Tag Rocket
Now navigate anywhere (eg homepage) with ?showevent=true at the end of your URL – this will switch your product cards into debug mode and highlight (in your browser only) when they are being correctly tracked . They will be highlighted blue when detected, orange when 50% is visible on the screen, purple when 50% for 2 seconds and red when the tracking event has been sent! If the product card is not highlighted it is not being tracked. This will detect both standard attributes and search provider attributes. To turn off the feature temporarily simply append ?showevent=false to the URL, to turn off permanently, disable the option in Tag Rocket and republish.
What to do if your Product Cards aren’t being tracked
Firstly check to see if any attributes exist. The bare minimum is that the product ID is present somewhere within the product card. If it is, we recommend contacting us via email to see if we can accommodate this format within Tag Rocket – make sure to provide the URL(s) of the page you need assistance with.
If the product id doesn’t exist in the product card HTML at all, you’ll need to determine if the HTML is provided by the theme or search provider and follow the below instructions:
Theme-based Attributes
If your theme is based on Cornerstone, the attributes may just need switching on. I’ll skip the background of why this is – you can read this article for the history. Search your theme files (an example of how here) for the presence of {{#if settings.data_tag_enabled}} checks littered throughout your theme. If they exist you’re in luck – simply strip them out or, for a quick fix, simply replace with “true”.
If these {{#if settings.data_tag_enabled}} checks don’t exist you’re out of luck. You’ll need to edit your theme to add the attributes which will be time consuming. You may be able to use the latest Cornerstone theme as a guide.
Search Provider Attributes
If the Search Provider you use isn’t currently providing these data attributes, you may be able to contact their support to have them added. Some may even provide the ability to customise your product card yourself such as DooFinder (Instructions).