Keyword widget

The ID of the widget, which can be found in the Widget Configurator in the Dashboard.

The example value shown here, 1jwy7eg9, is included for your convenience to send a request with Try It.

A first-party cookie created by the Bloomreach tracking pixel library (BrTrk).
This cookie creates a unique, anonymous identifier for every browser or device.
Use the default value provided, which is already encoded.

Your site domain's ID, which is provided by Bloomreach. This ID is for the domain that you want to receive your Bloomreach API requests.

This parameter identifies the specific site version when one account ID hosts multiple site versions with unique characteristics, such as language versions.
The example value shown here, bloomreach_devdocs, is included for your convenience to send a request with Try It.

Your site visitor's search query. Search queries are composed of one or more terms.
You can percent encode spaces between terms as %20, or you can leave the spaces unencoded.

The example value shown here, cable, is included for your convenience to send a request with Try It.

An ID to track site visitor clicks. We recommend that you generate unique, random values of 13 digits to enable click-tracking.
The request_id is also important for debugging.

The absolute URL of the page where the request is initiated. Don't use a relative URL.

The example value shown here, https://www.documentation-site.com, is included for your convenience to send a request with Try It.

The URL of the page or HTTP referrer where the request is started.

Required if you want to use Targeting.

A comma-separated list of fields to be sent in the request.

Alternatively, you may configure the fields in the Widget Configurator in the Dashboard instead.
This parameter is required if not sent via the Dashboard.

The filter parameter applies a faceted filter to the returned products, searching for products that fit your parameter values.

Any facet that you want to filter must be in your feed. Attributes must be enabled and mapped by Bloomreach.
Let your Bloomreach representative know which attributes in your content feed you want to apply as filters to search results.

You can filter results based on numeric ranges. For example, &filter=(price:["100" TO "*"]).
Note that a negative filter on ranges isn't supported.
To provide multiple filters, send multiple filter parameters.
For example, &filter=(price:["*" TO "100"])&filter=(color_groups: ("blue")).

With the filter parameter, after a user selects a facet value for filtering, the other facet values in that field are not returned by the API and are no longer visible.

The filter_facet parameter allows other facet values to be returned after a facet value has been selected.
filter_facet doesn't support complex boolean operations, but they can be supported by including both filter and filter_facet.
Note that the attributes used in filter will not return all values after the user selects a facet value in that field.

Example values:

Single filter with multiple values
&filter_facet=color:"red" OR "purple"

Multiple filters on different attributes
&filter_facet=color:"red"&filter_facet=brand:"Bloomreach"

A unique identifier for a specific view of your product catalog.
If you have multiple versions of your site, each with its own product catalog characteristics like product titles and prices, then add view_id to your call.
Bloomreach uses your view_id parameter value to display the right product information for your customers based on their individual site views.

You can enter any string value to identify the specific site catalog view. This string must be consistent in your pixel, API, and product catalog.

The universal customer ID of the user.
You only need to pass this field if your particular integration tracks customers this way.

The parameter captures user IDs from the customer side and reuses the information when powering apps or enhancing cross-device linking.
This way, Bloomreach recognizes users in a way that's aligned with your system.

Use an anonymous string. Don't use email or other personally identifiable information.