Integration Overview - Bloomreach Experience - Open Source CMS

Integration Overview

Pre-launch Phase
This page is about the Content Search (data-based) feature that is slated for launch in Q3 2020. To know more about this feature and activate/purchase the add-on module please reach out to your Bloomreach representative.

This section provides an overview of Content Search integration. The steps given below include everything you need to know from preparing and sending your data, setting up Content Search pixels and integrating the Content Search API. Detailed documentation for each of the steps is linked in the individual steps. 

1. Prepare your Data (Data Format)

As part of the integration, you must prepare your site data to make your content along with metadata searchable. Ensure that your data is in the required JSON format so that Bloomreach can process your data 

To read in detail about the data format required for Content Search, see the Format Your Data page.

2. Send your Data

Once your data is prepared as per the format prescribed (in Step 1), your data must be populated into a Catalog. A catalog is a dataset grouped together based on unique site attributes such as site ID (for multi-site accounts). To populate your catalog, send your data (in jsonl) to Bloomreach. You can choose any of the following two methods:

  • DataConnect PUT API (for first time upload of your data)
  • DataConnect PATCH API (for incremental changes to your data)

The step-by-step process of sending the data to Bloomreach is documented in Send your Data page. 

Configure Attributes in DataConnect

If you want to override the default configuration for search on your data, you can configure attributes individually via the DataConnect dashboard. Configuring attributes allows you to determine what should be made searchable in your dataset by overriding the default setting. To configure the attributes, follow the steps documented in the Configuring Attributes page. 

3. Integrate Pixels

A pixel is a JavaScript tracker that you must add to your website pages to capture customer actions. This data is used to power intelligent Content Search on your website. 

To integrate the pixel, add a Javascript snippet to all the pages, on all the versions- desktop, mobile, and tablet. You can simply add the tracking code snippet to your global footer to ensure it is added everywhere. Different events require different Javascript tracking snippets and should be added individually.

The following pixels are required to power Content Search:

  1. Search Page View Pixel
  2. Search Event Pixel
  3. Suggest Event Pixel
  4. Content Page View Pixel

You can read about the complete Pixel documentation for Content Search on the Pixel Deployment page. 

If you are an existing customer that already has the core Bloomreach Pixels, read about the use of the "catalogs" in the Pixel Deployment Page to understand how the Content Search Pixel works. 

4. Integrate Content Search API

The Content Search API sends a keyword query to retrieve results about content on your site. You can apply additional filters and facets to return content that either includes or exclude specified attributes like colors and brands. Before you integrate the API, make sure you understand how our APIs work by going through the API Deployment page.  

The complete API documentation for Content Search is available here

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?