Pixel Reference

Core Pixels

The core Bloomreach pixels consists 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 quick reference to all the variables in the table below:

Page ViewDescriptionRequired Pixel Variables
Global Page ViewEverytime a page loads, the global page view event is recorded.acct_id, ptype, titledomain_key, view_id, user_id, catalogs, tms, test_data.
Virtual Page ViewWhen 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.All Global Page View variablesorig_ref_url.
Product Page ViewWhen the product page is viewed.All Global Page View variables, prod_id, prod_name, sku, catalogs.
Content Page ViewWhen the content page is viewed.All Global Page View variables, item_id, item_name
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, 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, catalogs, tms, test_data
EventDescriptionRequired 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 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. 

Pathways and Recommendations

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

Event  Description  Required Pixel Variables
Widget ViewWhen a user views a widget within a page.widget_data.wridwidget_view_data.wqwidget_view_data.widwidget_view_data.wty
Widget ClickWhen a user clicks on a widget.widget_data.item_idwidget_data.wridwidget_view_data.widwidget_view_data.wqwidget_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.wridwidget_view_data.widwidget_view_data.wqwidget_view_data.wty

Relevance by Segment

If you are integrating the Relevance by Segment feature, you will need to add the following pixels.

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

📘

To view the native app implementation, go to Global Page View Pixel Variables (Native App).

Reference Table

This table lists all the variables and their details in the Bloomreach core pixels:

VariablePage View or EventType ExampleDescription
acct_idGlobal Page ViewString The Bloomreach-provided Account identifier. Must be consistent with acct_id passed in API call.
ptypeGlobal Page ViewStringhomepageMaps your site's page type classifications to the values Bloomreach expects for our page type classifications. 
titleGlobal Page ViewStringBlue Lace DressThe title of the current page. Bloomreach uses titles when listing pages in analytics reports for Insights. If you do not have <title> tags set in your HTML, you must add this variable to your pixel.Every page on your site should have a different title.
domain_keyGlobal Page ViewString_frThe Bloomreach-provided ID of the domain receiving the request. This parameter identifies the specific site language version when one account ID hosts multiple site versions with different languages. Bloomreach uses this value to ensure that only query and analytics data that pertain to that language are used for respective features.This parameter is only required if you integrate on a site with multiple language versions. Otherwise, domain_key should not be declared in the pixel as this will cause issues with analytics. Must be consistent with domain key passed in the API call.
view_idGlobal Page ViewString10200Identifies the specific site catalog view to show when one Bloomreach account ID hosts multiple site versions with unique product catalog characteristics, such as product price, availability, or title. Bloomreach uses View ID value to display the right product information for a user based on their site view. This must be consistent across the pixel, API and feed sent to Bloomreach. This parameter is only required if you integrate on a site with multiple site versions with unique product catalog characteristics. Otherwise, view_id should not be declared in the pixel as this will cause issues with analytics.
user_idGlobal Page ViewString947345478564If you track users via a universal customer ID, populate this parameter with that ID. This should be an anonymized string. It should not contain the user's email or other personally identifiable information.This parameter is only required if you track users via a universal customer ID. This will allow Bloomreach to recognize users in a way that is aligned with your system for various personalization features. If you do not track users this way, leave this blank. 
tmsGlobal Page ViewStringtlmIn case of migration from one tag manager to another, there may be a transition time frame, when the pixel is fired by two systems simultaneously. This parameter allows the Bloomreach analytics system to filter out duplicate pixels of the specified tag manager. Bloomreach has the following tag manager classifications: tms="tlm" for Tealium. Leave this field empty if you are not transitioning between tag managers.
test_dataGlobal Page ViewStringtrueFlags pixel data to be ignored during analytics processing. This ensures that you can fire the pixel in a test environment, allowing you to perform pixel validation without affecting your analytics data. Do not declare test_data in the pixel for your live site.
orig_ref_urlVirtual Page ViewStringhttps://myshop.comThe URL from which it is originally referred. 
catalogsContent Page View, Search Event, Suggest EventArray of Catalog objectsexample_en_prdList of catalogs that are shown in the page. In case the page has multiple tabs, only the catalogs of the selected (and visualized) tabs should be included. If multiple catalogs are shown in the active page (or tab) all of them should be included.
prod_idProduct Page View, Conversion Page View (in the basket), ATC Event, Quick View EventStringprod1234The unique product ID, which describes a product, product bundle, product collection or sku set. If a product is available in multiple SKUs (e.g. color/size combinations), this field refers to the id shared by all the SKUs for a product.
prod_nameProduct Page View, ATC Event (native app only), Quick View EventStringBlue Lace DressThe name of the product being viewed.
skuProduct Page View, Conversion Page View (in the basket), ATC Event, Quick View EventStringsku7778Unique sku ID that representing the selected variant of this product (e.g. size M, color blue of a t-shirt). Needs to match the sku ID field in the feed. If your site does not have SKUs, leave this blank.
item_idContent Page ViewStringrecipe115718079035Unique ID of the item being shown in the page. This identifier should match the item_id as specified in the feed.
item_nameContent Page ViewStringCalifornia Avocado Omelette RecipeName or the title of the Content page.
cat_idCategory Page ViewString106120106121
catCategory Page ViewString106120106121
sid String To be used only if you are integrating brSEO. If you have set the javascript variable br_related_rid correctly, as mentioned in the Widget Integration Test Scenario BrTrk will automatically populate this sid field. Please ensure that br_related_rid is set correctly.
search_termSearch Result Page ViewStringblue dressThe value of the search query describing the page.
aqSuggest EventStringwoThe display query (the one or more letters) that the user has actually typed. 
This is NOT the suggested word or phrase.
qSearch Event, Suggest EventStringwoven scarfUser's typed search query submitted to search box
order_idConversion Page ViewString1234567The order id associated with the order placed. This id should match the orderID used in your analytics systems.This id has to match the orderID used in your analytics systems.
basket_valueConversion Page ViewString This basket value has to match the basket value used in your analytics systems.The total price of the checkout basket without any symbols including tax, discounts, shipping and/or discounts in the account currency. If the checkout basket was $100 with $5 tax and $10 shipping, the value for this parameter should be br_data.basket_value="115.00".
basketConversion Page ViewThis object contains a property called `items` which is an array of the product objects purchased.Detailed conversion parameters for each product that was purchased.
currencyGlobal Page ViewStringGBPCurrency code for the transaction. Defaults to USD. Supported currencies: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTC, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMW, ZWL

Pathways and Recommendations

VariablePage View or EventType ExampleDescription
widget_data.wrid Stringabcd123The unique ID of the response. This value has to be populated from the API response metadata.widget.rid.
widget_view_data.wqStringblack dressThe query string used by the customer which returns a widget suggestion. This is optional for non-query widgets.
widget_view_data.widStringabc123The widget ID. This is a unique, 6 character alphanumeric value. This value has to be populated from the API response metadata.widget.id.
widget_view_data.wty Stringsearch,mlt, etc. The type of recommendation widget. This value has to be populated from the API response.This value has to be populated from the API response metadata.widget.type.
widget_data.item_id Numericpd123The unique ID (PID) of the clicked product. The PID is used from the API call.
widget_atc_data.sku Stringsku123Unique SKU id that represents the selected variant of this product (e.g. size M, color blue of a t-shirt). If your site does not have SKUs, leave this blank.

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

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

VariableDescriptionExample value
cookie2Anonymously identifies a particular device instance using a unique user ID (UUID). Format is uid={{UUID}}:v=app:ts=0:hc={{hitcount}}

For the UUID, we suggest the following:

iOS devices - use the IDFA
Android devices - use the Android Advertising ID
* Other devices - use the closest equivalent

The hitcount value should be 1 for a new visitor, or 2 for returning visitors.
uid%3D1e7724c751a3f6e6241018d150144832e7528383%3Av%3Dapp%3Ats%3D0%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
urlSynthetic unique URL composed of a static base URL and a screen app screen name.

Base URL: http://merchantname.app/

To help maintain uniqueness, prefix the screen name with the page type classification.

http://merchantname.app/{{ptype}}/{{title}}

ptype and title values here should match the values in their respective variables.
http%3A%2F%2Fmerchantname.app%2Fproduct%2Fblue%2520lace%2520dress
refSynthetic URL from referrer screen. Follows same format as url param above.http%3A%2F%2Fmerchantname.app%2Fcategory%2Fdresses
typeThe type of tracking fire. For pageviews, type=pageviewpageview

Did this page help you?