Pixel Checklist
This is a quick checklist of all Pixel variables for different event types and feature pixels.
Core Pixels
The core Bloomreach pixels consist of the Page View Pixels and the Event Pixels that capture site interactions. It is mandatory to install these for all integrations. You can find a checklist of all the variables in the tables below:
Base Variables
| Applicable to | Description | Required Variables |
|---|---|---|
| Global tracking | This 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 |
| Single Page Application tracking | When 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 Event | Description | Required Pixel Variables |
|---|---|---|
| Product Page View | When the product page is viewed. | All Global tracking variables, prod_id, prod_name, sku |
| Content Page View | When the content page is viewed. | All Global tracking variables, item_id, item_name, catalogs |
| Category Page View | When a category page is viewed. | All Global tracking variables, cat_id, cat |
| Search Result Page View | When a search result page is viewed. | All Global tracking variables, search_term, catalogs (if you have at least 1 catalog where the data type is content) |
| Conversion Page View (Thank you Page Tracking) | When the "Thank You" page is viewed. | All Global tracking variables, is_conversion, order_id, basket_value, basket, currency |
| Thematic Page | When 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 Events | Description | Required Pixel Variables |
|---|---|---|
| Add-to-cart | Any time a user adds an item to their cart. | prod_id, sku |
| Search | When 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 |
| Suggest | When a user clicks on a search suggestion, provided the autosuggest feature is enabled. | aq, q, catalogs |
| Quick View | Anytime 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:
| Event | Description | Required Pixel Variables |
|---|---|---|
| Widget View | When a user views a widget within a page. | widget_data.wrid, widget_view_data.wq, widget_view_data.wid, widget_view_data.wty |
| Widget Click | When 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-cart | When 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 name | Description | Sample values |
|---|---|---|
| customer_tier | Tier that the user belongs to. | Premium Gold Base |
| customer_country | Country that the user belongs to or is accessing the site from. | US Australia |
| customer_geo | Geography or Region that the user belongs to. | Florida Asia |
| customer_profile | Profile 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:
| Variable | Description | Example value |
|---|---|---|
| cookie2 | Anonymous 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 generatedhitcount - 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 |
| rand | A random number that is added to request to make sure browsers and proxies don't cache requests. | 79069731271669680 |
| title | Screen name of the app view. | Blue%20Lace%20Dress |
| url | In 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” |
| ref | Synthetic URL from referrer screen. Follows the same format as the url param above. | "http://v11.0-android.app.homeoasis.com/category/mens-clothes" |
| type | The type of tracking fire. For pageviews, type=pageview | pageview |
Updated about 2 months ago