Pixel Checklist

This is a quick checklist of all Pixel variables for different event types and feature pixels.

Core Pixel

The core Bloomreach pixels consist of the Page View Pixels and the Event Pixels that capture site interactions. These are mandatory to be installed for all integrations. You can find a checklist of all the variables in the tables below:

Base Variables

Applicable toDescriptionRequired Variables
Global Page View trackingThis is the master template you must modify/override for each event type (page view or other events).acct_id, ptype, title, domain_key, view_id, user_id, tms, test_data
Virtual Page View trackingWhen there are other page views for the same page URL, the virtual page variables capture the impression of that page being loaded more than once. This enables you to trigger pageview when tracking on single-page applications (SPAs).All Global Page View variables, orig_ref_url.

Event Specific Variables

Page View EventDescriptionRequired Pixel Variables
Product Page ViewWhen the product page is viewed.All Global Page View variables, prod_id, prod_name, sku
Content Page ViewWhen the content page is viewed.All Global Page View variables, item_id, item_name, catalogs
Category Page ViewWhen a category page is viewed.All Global Page View variables, cat_id, cat
Search Result Page ViewWhen a search result page is viewed.All Global Page View variables, catalogs, search_term
Conversion Page View (Thank you Page Tracking)When the "Thank You" page is viewed.All Global Page View variables, is_conversion, order_id, basket_value, basket
Thematic PageWhen you are integrating the brSEO pixels. In this case, the 'ptype' should be "thematic"acct_id, ptype, domain_key, view_id, user_id, tms, test_data
Other EventsDescriptionRequired Pixel Variables
Add-to-cartAny time a user adds an item to their cart.prod_id, sku
SearchWhen a user types a search query in the search box and then clicks the search button or hits enter to submit the search.q, catalogs
SuggestWhen a user clicks on a search suggestion, provided the autosuggest feature is enabled.aq, q, catalogs
Quick ViewAnytime a user opens a Quick View to display more details about a product on your site.prod_id, prod_name, sku

Feature Specific Pixels

Based on the Bloomreach feature you are integrating, also add the feature-specific Bloomreach pixels described below. Remember, irrespective of which feature pixels you add, the Bloomreach core pixels must be added to your pages.

Recommendations and Pathways

If you are integrating Recommendations and Pathways, you must add the Pixel variables for the following event types:

EventDescriptionRequired Pixel Variables
Widget ViewWhen a user views a widget within a page.widget_data.wrid, widget_view_data.wq, widget_view_data.wid, widget_view_data.wty
Widget ClickWhen a user clicks on a widget.widget_data.item_id, widget_data.wrid, widget_view_data.wid, widget_view_data.wq, widget_view_data.wty
Add-to-cartWhen the ATC button placed within the widget is clicked.widget_data.item_id, widget_data.sku (optional), widget_data.wrid, widget_view_data.wid, widget_view_data.wq, widget_view_data.wty

Relevance by Segment

If you are integrating the Relevance by Segment feature, you will need to update all pixels with new parameters.

Add pixel parameters containing segment name and values to capture analytics for those segments. Segment information must be added to all pixel event types. Currently, the following segments are supported:

Segment nameDescriptionSample values
customer_tierTier that the user belongs to.Premium
Gold
Base
customer_countryCountry that the user belongs to or is accessing the site from.US
Australia
customer_geoGeography or Region that the user belongs to.Florida
Asia
customer_profileProfile of the user.Healthcare
Cleaning

Global Page View Variables (Native App/non-JS Environment)

The Native App or non-JS environment pixel requires all Javascript global page view variables (see the table above), as well as the variables in the following table:

VariableDescriptionExample value
cookie2Anonymous identifier for a particular browser or device instance using a randomly generated unique user ID. Value is usually stored as a browser cookie. Format is:

uid={{cookie_uid}}:v={{tracker_version}}:ts={{unix_timestamp}}:hc={{hitcount}}

cookie_uid - random 10-13 digit number generated on first visit in the browser or device and stored as a cookie or in local storage on the device, must respect customer privacy choices, example JS: Math.round(Math.random() * 10E12);

tracker_version - version of used tracker (from SDK); for direct API calls use “app”

ts - unix epoch timestamp in seconds when cookie_uid was generated

hitcount - value should be 1 for a new visitor, and incrementing with every subsequent pixel fired.
- uid=3510849277068:v=11.8:ts=1636626614546:hc=1`
- URI Encoded
`cookie2=uid%3D3510849277068%3Av%3D11.8%3Ats%3D1636626614546%3Ahc%3D1
randA random number that is added to request to make sure browsers and proxies don't cache requests.79069731271669680
titleScreen name of the app view.Blue%20Lace%20Dress
urlIn the context of native (mobile) apps, the "url" parameter should be a synthetic unique URL composed of a static base URL and the screen app screen name. To maintain uniqueness, the base URL should be prefixed with OS and application version, should be prefixed with the page type classification, and then followed by the title. For example, synthetic URL: http://{releaseversion}-{operatingSystem}.app.merchantname.com/category/mens-clothes.The URL could be structured with the ptype and title matching the values of their respective variables in the pixel. This URL is used to uniquely identify the page/content being viewed for tracking purposes.

Release version and operating system are proven to be useful for troubleshooting the release that caused it.
http://v11.0-android.app.homeoasis.com/category/mens-clothes”
refSynthetic URL from referrer screen. Follows same format as url param above."http://v11.0-android.app.homeoasis.com/category/mens-clothes"
typeThe type of tracking fire. For pageviews, type=pageviewpageview