Category Page View Pixel - Bloomreach Experience - Open Source CMS

Category Page View Pixel

Category Page View Tracking 

Go to your Category Page Template and add the category specific tracking parameters in the Global Tracking snippet. If your category pages are loaded via Dynamic Refresh outside the regular page load cycle, please add additional handlers to be able to track virtual page view interactions.

Faceting, Filtering and Pagination on Category Pages

If a user applies a facet filter and refreshes results, Bloomreach expects that the Category Page View pixel fires each time a filter is applied. Bloomreach uses this information to understand which filters are commonly used. In case your implementation is such that pages don't reload when a user applies a filter or facet, please add additional handlers to each filter/ facet to be able to track virtual page view interactions.
If your category pages are paginated, Bloomreach expects that the Category Page View pixel fires each time a user navigates to the next or previous category page. If your category pages don't reload when a user navigates to the next or previous page, please add additional handlers to the 'next' and 'previous' links to be able to track virtual page view interactions

Category Page View Code Snippet

<script type="text/javascript">
  var br_data = br_data || {};
  // Global tracking parameters
  br_data.acct_id = "<Bloomreach Provided Account ID>"; 
  br_data.ptype = "category";
  br_data.domain_key = "";
  br_data.catalogs = [ { "name" : "example_en_prd" } ];
  br_data.user_id = "";
  br_data.view_id = "";
  br_data.tms = ""
 
  // INSERT the Category specific Tracking Parameters in your Global Tracking Script
  // in your CATEGORY PAGE TEMPLATE.
  br_data.cat_id = "106121";
  br_data.cat = "106120|106121";
 // End - Category page specific tracking parameters
   
   
  (function() {
  var brtrk = document.createElement('script');
  brtrk.type = 'text/javascript';
  brtrk.async = true;
  brtrk.src = "//cdn.brcdn.com/v1/br-trk-{{BloomReach Account ID}}.js";
  var s = document.getElementsByTagName('script')[0];
  s.parentNode.insertBefore(brtrk, s);
  })();
</script>

Category specific Page View Variables

Map these data variables in your Page view code snippet

Category ID

Variable

Type

Dependencies

Description

br_data.cat_id String 
This field value is case-sensitive.

The category ID needs to match the "crumb_id" in the feed.

For Search implementations, the unique category ID needs to be passed in the API call.

Unique category ID as referred to in the database/catalog.
Bloomreach requires the cat_id field to be unique across your site.

Scenario

Examples

Unique Category ID (preferred scenario)

Your site has has a unique category ID for every category, e.g.
Home = cat ID: 106119
Clothing = cat ID: 106120
Outerware = cat ID: 106121, then Bloomreach expects the leaf node Category ID to be sent in the pixel.

Variable Example: 
br_data.cat_id="106121"

No unique category ID, but unique crumb path

Your site page does not have a unique category ID for every category, but it has a unique crumb path for every category.
In this case, we ask you to concatenate the unique crumb path without any delimiters or special characters and send the value in the cat_id field.


Variable Example: 
Your unique crumb path is " jewelry|by-collection|inspirational-jewelry"
br_data.cat_id="jewelrybycollectioninspirationaljewelry"

No unique category ID and No unique crumb path Please talk to your Bloomreach TPM before or during the Kickoff call to discuss options for your implementation.

Category Name/ Bread crumb

Variable

Type

Dependencies

Description

br_data.cat  String
Crumbs need to be delimited by pipe (|) 
Match the "crumbs" field in the product feed The breadcrumb of the page.

Scenario

Examples

If you have a numeric representation of your bread crumb

Your site shows Home/Top/Casual Top and each of the bread crumbs have a numeric representation, such as 
Home = 106120 
Top = 106121 
Casual Top = 106122, the Bloomreach Pixel expects the full bread crumb path, separated by pipe (|).

Variable Format: 
br_data.cat=" <top level crumb>|<first level crumb>|<second level crumb>" 

Variable Example: 
br_data.cat="106120|106121|106122"

Unique breadcrumb path Your site has a unique bread crumb path for every category.

Variable Format: 
br_data.cat="<top level crumb>|<first level crumb>|<second level crumb>"
Crumbs need to be delimited by pipe (|) 

Variable Example: 
If your category crumb is "Home/Clothing/Outerwear" or "Home>Clothing>Outerwear" 
br_data.cat="Home|Clothing|Outerwear"
No unique category ID and Nounique crumb path Please talk to your Bloomreach TPM before or during the Kickoff call to discuss options for your implementation.

Catalogs

Variable

Format

Example

Description

br_data.catalogs

Array of Catalog objects

"[ { "name" : "example_en_prd" } ]"

List 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.

Native App Implementation

You can include the Global View variables and the following variables for native app implementation. For details on the native app implementation format, refer to the Non-JS Environment section in the Getting Started page. 

  • ptype (see above)
  • cat_id (see above)
  • cat (see above)
Refer to the Implementation Scenarios above for specific use cases of cat_id and cat.

Example requests:

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?