Conversion Page View Pixel - Bloomreach Experience - Headless Digital Experience Platform
Hippo CMS

Conversion Page View Pixel

Conversion Page View Tracking

Go to your Conversion/ Thank You Page Template and add basket and Conversion specific Page View parameters in the Global Tracking snippet. If your checkout pages are loaded via Dynamic Refresh, please add additional handlers to be able to track virtual page view interactions.

Conversion/ Thank You Page View - Implemenation Example

<script type="text/javascript">
  var br_data = br_data || {};
  // Global tracking parameters
  br_data.acct_id = "<Bloomreach Provided Account ID>"; 
  br_data.ptype = "other";
  br_data.title = "<title of current page>";
  br_data.domain_key = "";
  br_data.catalogs = [ { name : "<example_en_prd>" } ]; 
  br_data.user_id = "";
  br_data.view_id = "";
  br_data.tms = ""
 
  // INSERT the Conversion & Basket specific Tracking Parameters in your Global Tracking Script
  // in your CONVERSION/ THANK YOU PAGE TEMPLATE. 
   br_data.is_conversion = 1;
   br_data.basket_value = "445.93";
   br_data.order_id = "12123455";
   br_data.basket =
   { "items":
    [
    {
      "prod_id" : "pid1111",
      "sku": "sku1234",
      "name": "Linen Pillow",
      "quantity": "1",
      "price": "35.95"
    },
    {
      "prod_id" : "pid2222",
      "sku": "",
      "name": "Linen Comforter",
      "quantity": "1",
      "price": "230.00"
    }, 
    {
      "prod_id" : "pid56789",
      "sku": "",
      "name": "Blue Skinny Jeans",
      "quantity": "2",
      "price": "79.99"
    }
   ]
  };
 ;
  // End - Conversion 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>

Conversion/ Thank You Page Variables

Map data variables in your Pageview code snippet

 Is Conversion

Variable

Type

Example

Dependencies

Description
br_data.is_conversion Integer br_data.is_conversion=1 N/A Set to 1 on the Conversion or Thank you page 
(page after the customer completes the purchase). 

For Conversion Pages only.

Order ID

Variable

Type

Example

Dependencies

Description
br_data.order_id String br_data.order_id="12123455" This id has to match the orderID used in your analytics systems The order id associated with the order placed. This id should match the orderID used in your analytics systems.

For Conversion pages only

Additional Information
The Order ID is used to reconcile Bloomreach's analytics data with your analytics systems.

Basket Value

Variable

Type

Example

Dependencies

Description
br_data.basket_value String 

Variable Format:
The total price of the checkout basket in the account currency without any symbols.

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

 This basket value has to match the basket value used in your analytics systems. The total price of the checkout basket including tax, discounts, shipping and/or discounts in the account currency. For Conversion pages only.

Scenario

Example
Your analytics system calculates basket value with tax & shipping

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"
Your analytics system calculates checkout with discount, tax & shipping If the checkout basket was $100 with $0 tax, $10 discount and $10 shipping, the value for this parameter should be 
br_data.basket_value= "100.00"

Basket

Variable

 Type

Description
br_data.basket

Object

This object contains a property called `items` which is an array of the product objects purchased. For each product in the `items` array, the following properties should be included as specified:

{ "items":
   [
    {
      "prod_id" : "pid123456",
      "sku": "sku789",
      "name": "Cashmere Sweater",
      "quantity": "1",
      "price": "65.95"
    },
    {
      "prod_id" : "pid56789",
      "sku": "",
      "name": "Blue Skinny Jeans",
      "quantity": "2",
      "price": "79.99"
    }
   ]
};
 Detailed conversion parameters for each product that was purchased. 

For Conversion pages only.

Basket Object Items

Type

Dependency

Description
prod_id String Needs to match Product ID sent in feed

This is the unique ID, which describes a product, product bundle, product collection or sku set.
sku String Needs to match SKU ID sent in feed.

Only applies if your site has SKUs.		 If your site has skus, list the sku(s) in the basket.
name String   The name of the product in the basket.
quantity Integer N/A The quantity of the product in the basket.
price String   The unit price *per* product, not the total price. 
If item is on sale, this is the unit sale price.

Scenario

Example
2 Products, 
→ the first product has a sku, 
→ the second product does not have a Sku

2 products, first product has a sku, second product does not have a sku.

First Product: Individual Product 
Product ID: pid123456
Sku ID: sku789

Second Product: Individual Product
Product ID: pid56789

{ "items":
   [
    {
      "prod_id" : "pid123456",
      "sku": "sku789",
      "name": "Cashmere Sweater",
      "quantity": "1",
      "price": "65.95"
    },
    {
      "prod_id" : "pid56789",
      "sku": "",
      "name": "Blue Skinny Jeans",
      "quantity": "2"
      "price": "79.99"
    }
   ]
};
2 Products, 
→ the first product (Pullover) was purchased in White and Blue (2 different Skus) 
→ the second product does not have a Sku

The first product was purchased in two Skus (e.g. a Pullover purchased in white and blue), the second product does not have a sku.

First Product: Individual Product purchased in 2 Skus 
Product ID (e.g. Pullover): pid123456
Sku ID 1 (white): sku789
Sku ID 2 (blue): sku790

Second Product: Individual Product
Product ID: pid56789

{ "items":
   [
    {
      "prod_id" : "pid123456",
      "sku": "sku789",
      "name": "Cashmere Sweater White",
      "quantity": "2",
      "price": "120.00"
    },
    {
      "prod_id" : "pid123456",
      "sku": "sku790",
      "name": "Cashmere Sweater Blue",
      "quantity": "1",
      "price": "60.00"
    },
    {
      "prod_id" : "pid56789",
      "sku": "",
      "name": "Blue Skinny Jeans",
      "quantity": "2",
      "price": "79.99"
    }
   ]
};
2 Products, 
→ the first product is a Product Collection with its own unique ID and is sold exactly like a standalone product 
→ the second product is an individual product.

If your Collection Pages have their own unique IDs and are sold exactly like standalone products, then enter the collection ID in the prod_id field. Make sure that this collection ID is sent in the feed in the product ID field.

First Product: Product Collection 
Collection ID: collection223344

Second Product: Individual Product
Product ID: pid56789

{ "items":
   [
    {
      "prod_id" : "collection223344",
      "sku": "",
      "name": "Linen Bed Sheet Set",
      "quantity": "1",
      "price": "265.95"
    },
    {
      "prod_id" : "pid56789",
      "sku": "",
      "name": "Blue Skinny Jeans",
      "quantity": "2",
      "price": "79.99"
    }
   ]
};
2 Products, 
→ the first product is a Product Collection/Sku Set with 2 individual products. The Collection has its own unique ID but it cannot be purchased as a whole
→ the second product is an individual product.

Your Product Collections have their own unique IDs, but cannot be purchased as a whole; only the collections' individual parts/products can be purchased and each of these individual parts have their own ID. In this case, list all individual products in the basket and the prod_id is the ID of each product. 

First Product: Product Collection 
Collection ID: collection223344 with 2 individuals products.
Product ID: pid1111
Product ID: pid2222

Second Product: Individual Product
Product ID: pid56789


Make sure that each product ID is sent in the feed in the product ID field.

{ "items":
   [
    {
      "prod_id" : "pid1111",
      "sku": "",
      "name": "Linen Pillow",
      "quantity": "1",
      "price": "35.95"
    },
    {
      "prod_id" : "pid2222",
      "sku": "",
      "name": "Linen Comforter",
      "quantity": "1",
      "price": "230.00"
    }, 
    {
      "prod_id" : "pid56789",
      "sku": "",
      "name": "Blue Skinny Jeans",
      "quantity": "2",
      "price": "79.99"
    }
   ]
};
2 Products, 
→ the first product is a Product Collection/Sku Set with 2 individual products. The products are part of a collection, but can be purchased from their own individual product page. 
→ the second product is an individual product.		 If your products are part of a Collection but can only be purchased from their own individual product page, then enter the product ID in the prod_id field
 

First Product: Product Collection 
Collection ID: collection223344 with 2 individual products.
Product ID: pid1111
Product ID: pid2222

Second Product: Individual Product
Product ID: pid56789

{ "items":
   [
    {
      "prod_id" : "pid1111",
      "sku": "",
      "name": "Linen Pillow",
      "quantity": "1",
      "price": "35.95"
    },
    {
      "prod_id" : "pid2222",
      "sku": "",
      "name": "Linen Comforter",
      "quantity": "1",
      "price": "230.00"
    }, 
    {
      "prod_id" : "pid56789",
      "sku": "",
      "name": "Blue Skinny Jeans",
      "quantity": "2",
      "price": "79.99"
    }
   ]
};

Additional Information

The key-value data you send us in the basket will be transformed into the format below in the executed pixel (pix.gif) file:

E.g. !ipid123456'ssku789'nCashmere Sweater'q1.0'p69.95!ipid56789'nBlue Skinny Jeans'q1.0'p79.99

Each product in the cart will be separated by !. Each product's details will be separated by '.

  1. i<prod_id> - This is the product id and not another id such as sku id or collection id. This should match the unique product id sent in the feed.

  2. s<sku> - Sku id, only applies if you have skus.

  3. n<product_name>

  4. q<quantity>

  5. p<price> - This should be the unit price per product and not total price. If the item is on sale, this is the unit sale price. 

Native App Implementation

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

  • is_conversion (see above)
  • basket_value (see above)
  • order_id (see above)
  • basket (see Additional Information on Basket above)
    • Do not percent encode the ! separators

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?