Widget Configurator - Bloomreach Experience - The Headless Digital Experience Platform Built for Commerce

Widget Configurator

The Widget Configurator is a functionality within the Bloomreach Dashboard that allows you to create and manage the Pathways and Recommendation widgets easily. Some of the operations possible with the Widget Configurator are:

  • Create a Widget
  • Manage a Widget
  • Delete a Widget
  • Change the Widget Type

Create a Widget

You can create a widget for Pathways and Recommendations from the Dashboard by following the steps given below. The creation of a widget is the first step in the widget integration process. When you create a widget ,you can create Widget Global merchandising Rules. You can further create and apply widget query level rules as well. You can read more about Merchandising for Pathways & Recommendations in the Merchandising sub section. 

Create Widget in Staging
When you first create a widget, perform this step in your staging Dashboard to test it in your staging environment. You can recreate this widget in your production environment later. Remember that when you recreate this in production, the widget ID will be different since you originally added the widget in staging.
  1. Log in to the Bloomreach Dashboard- https://tools.bloomreach.com/. For EMEA customers, use https://tools.bloomreach.co.uk)
  2. Go to Pathways & Recommendations > Widget Configurator.
  3. Click Add Widget.
  4. Configure the following details in the Widget Basic Info screen:
  • Widget Name: A friendly name for the widget which will be used in the Dashboard.
  • Widget Description: An optional description that helps you add more details on what the widget use-case.
  • Primary Algorithm: Select the type of algorithm that you want the widget to use. You can select from the following options:   


  • Secondary Algorithm: Select the alternate algorithm you want the widget to use in case there isn't sufficient data for the primary algorithm. The secondary algorithm cannot be defined for Pathways widgets. To read about which secondary algorithm selection is allowed, go to the Secondary Algorithm Selection page. 
  • Result Size: The minimum number of products you want the widgets to display. The default number is 15. This also acts as the threshold to display the Secondary widget.
  • FL list: The list of product attributes to return for each product displayed in the widget. You can select attributes such as Brand, Category, Price, Sale Price, Size, Style, etc. This is the exact data returned by the API. 
  • Copy Configurations: At widget creation, you can choose to copy configurations (widget global ranking and widget query rules) from an existing widget. This is a one-time-only operation.

           5. Click Next Step to proceed. 

           6. You can now apply the global merchandising rule for the Widget as described in the Pathways and Recommendations Merchandising page.

Numeric Sorting

You can now sort attributes with numeric values such as price when you set merchandising rules such as boost and bury. 

Given below is an example of applying the merchandising query rule for the color attribute "black" on a co-viewed widget:

Sonia, a digital merchandiser at Homeoasis has created a widget "Bought with This" with the algorithm "Frequently Bought Together" for White Tops and wants to show other leather shoes in the color black as it is the most fast-moving color in this category. Sonia has to create an attribute rule for the color "black" and apply a product boost based on this rule so that other black leather shoes surface upon search. 

The steps Sonia must follow are:

               a. On the Product Grid > Add Additional Attribute Rule > Product Description Attributes > colour_groups > white and Operation is turned ON.

This setting will boost similar products that have the color white in the widget grid.  

Getting the Widget ID

Once the widget is created note down the widget_id as it will be required in the API call. The widget ID is the alphanumeric value available in the Widget Configurator's main screen.

Before Deploying to Production

Before you begin deploying your widgets into production, ensure that you have first used the staging environment of your Dashboard for important steps given below:

Implement UI (Staging)

After you have created your widgets, in your staging environment, you will need to implement the widget UI and determine where to display the widget.

Suggested Widget UI Placements for Custom Pathways

Widget type

Placement Location

New Arrivals

Department landing and search/category pages, above the fold.

Own Brand

Department landing and search/category pages, above the fold.

Excess Inventory

Search/category pages

On Sale

Department landing pages and search grid pages, above the fold.

New Since Last Visit

Department landing pages, above the fold.

Recipe pages

Recipe blog/article pages

Curated widget

Any page, depending on the widget

Category widget

PDPs, department landing, blog, and recipe pages

Suggested UI Placements for Recommendations Pathways Widgets

Widget type

Placement Location

Frequently bought together

PDPs , Cart , Checkout

Frequently viewed together


Similar Products


QA & Acceptance Testing 

We recommend that you perform QA and acceptance testing of your changes in staging before going live in the production site.


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?