Getting Started - Bloomreach Experience - Open Source CMS

Getting Started

This guide will give you an overview of the Bloomreach pixels and what you need to get started with the pixel integration. 

What is a pixel?

A pixel is a JavaScript code that you must add to your site’s pages to send necessary data to Bloomreach. The pixels track your customer's activities on your site such as page views, clicks on products, search, add-to-cart etc. which add behavioural learning data to the Bloomreach's algorithm. Over a period of time, data captured by the pixel amounts to a powerful, intuitive search solution that powers all our solutions. 

Why do I need pixels?

Pixel are an important part of your integration because of the following reasons: 

  • Bloomreach uses the information captured by the pixels to learn about your site and your customers to dynamically optimize Bloomreach features.

  • It is the primary component to generate site analytics (Insights) that give you visibility into how customers use your site (and track conversions) so that you can take informed, strategic decisions to grow your business. 

How do pixels work?

The Bloomreach pixels added to your site, loads along with the rest of your site’s code. When a customer visits your site, the pixels pick up activities as events and sends them to Bloomreach.

Pixel Location

The pixels must be added to every page and every version of your site, including desktop, mobile, and tablet. A typical strategy includes simply adding the tracking code snippet to your global footer. 

Bloomreach provides pixels support for the following implementations:

  • JavaScript Environment Pixel (web, mobile web) to mplement JS based Bloomreach pixels on your web pages or web mobile. 
  • Non - JavaScript Environment Pixel (native app) to implement non-JS Bloomreach pixels on your native app. This is required for any device where JS is not executed. Check out the Native App Implementation section within each type of pixel pages for more details.  
Don't add Pixels to pages where PII is passed
Some pages include Personally Identifiable Information (PII), especially registration pages and secure login pages, payment details pages, delivery information pages, account settings pages, etc. Bloomreach does not collect PII. We recommend against integrating the pixels on pages with this kind of information.

Do not add the pixels on pages where PII is passed. The pixel itself is fully compliant with SSL. Bloomreach ensures maximum privacy for your customers and does not track changes on pages where PII is entered or exchanged within your website.

How do I add the Bloomreach Pixels?

JS Environment

To integrate Bloomreach pixels in the JavaScript environment, you can choose any one of the following options:

  • Add manually by installing the Pixel on your site

    The Bloomreach pixel consists of 5 event tags for tracking Page Views, Add to Cart, Search, Suggest and Quick View actions. Learn more.
     
  • Add using a Tag Manager

    If your website uses a tag manager such as GTM or Ensighten, you can use your tag manager to easily place the Bloomreach Pixel on your website. Learn more. 
For the best optimization and personalization, ensure that every page has the pixels installed. 

Non-JS Environment

To integrate Bloomreach pixels on your native app, you must generate HTTP GET requests to one of the following secure endpoints:

  • https://p.brsrvr.com/pix.gif (for North America)
  • https://p-eu.brsrvr.com/pix.gif (for Europe)
  • If you are not from North America or Europe, Bloomreach will advise you on which endpoint to use during integration, but you may use either endpoints. Consult your Bloomreach representative if you are unsure. 

The analytics data for each request is encoded in the URL query string as parameter pairs, such as &type=pageview. Each parameter pair has a key and value, and must follow the requirements given below:

  • Format should be in key-value pair. For example: key=value
  • Multiple pairs should be delimited by an ampersand "&". For example, key1=value1&key2=value2
  • Must be UTF-8
  • The value must be percent-encoded
  • Parameters must be appended to the end of the endpoint. For example: https://p.brsrvr.com/pix.gif?acct_id=&type=pageview

If the HTTP request is received, we return a 200 status code. The Content-Type will be image/gif and the content will be a 1x1 transparent gif image.

The HTTP response does not return an error code if the data was malformed, or if the data in the payload was incorrect or was not processed by Bloomreach. If you do not get a 200 status code, you should not retry the request. Instead, verify your HTTP request to ensure that it does not contain any errors.

For more information on integrating pixels on Native App, look out for Native App support within each pixel integration pages. This integration works differently than the web based pixels. 

Which Bloomreach Pixels do I need?

By default, all Bloomreach integrations will need the core Bloomreach pixels. Additionally, there are different Bloomreach pixels for optimising different features. You will need different pixels based on the Bloomreach solution that you are integrating. See the Feature Specific Pixels for more.

Core Pixels 

The core pixels for Bloomreach consists of the following types based on interactions: 

Feature Pixels

Based on the feature that you are integrating, you will need additional pixels other than the core pixels. The feature specific pixels are additive so you will need only a few additional pixel variables. To get a quick view of the variables, go to the Pixel Reference page. 

The feature specific pixels available are:

The table below gives you a quick reference to the pixels you will need for your integration based on the feature: 

Bloomreach Solution Core Pixels Feature Pixels
Search

NA
Organic Search (brSEO)

SEO tracking is captured by defining the ptype variable. Learn more here
Pathways and Recommendations

 

Pathways and Recommendations Pixels
Relevance by Segment 

Relevance by Segment Pixels

Implementation Steps

To implement the Bloomreach pixels, follow the steps given below: 

  1. Add Bloomreach Core Pixels

  2. Add Product Specific Pixels (optional)

  3. Verify Pixels (This is the final step where you can verify the pixel setup by testing your pixel configurations).

Need Help?

For help or feedback on the Bloomreach pixel integrations, please contact your Bloomreach representative.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?