Global widget

get

https://pathways.dxpapi.com/api/v2/widgets/global/{widget_id}

This API allows you to fetch the global widget for trending products.

Endpoints

Production: https://pathways.dxpapi.com/api/v2/widgets/global/{widget_id}
Staging: https://pathways-staging.dxpapi.com/api/v2/widgets/global/{widget_id}

The widget_id can be found in the Widget Configurator in the Dashboard.

📘
For more detailed information of any of the following API parameters, refer to the Recommendations and Pathways parameters reference.

Path Params

widget_id

string

required

Defaults to 1jwy7eg9

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.

Query Params

account_id

int32

required

Defaults to 6276

Your site's numerical Bloomreach account ID.

Your Bloomreach representative gives your site's account ID to you before or during your integration kickoff meeting.
The example value shown here, 6276, is included for your convenience to send a request with Try It.

_br_uid_2

string

required

Defaults to uid%3D7797686432023%3Av%3D11.5%3Ats%3D1428617911187%3Ahc%3D55

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.

domain_key

string

required

Defaults to bloomreach_devdocs

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.

request_id

string

required

Defaults to abh3kjh1kjnd8

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.

url

string

required

Defaults to https://www.documentation-site.com

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.

ref_url

string

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

Required if you want to use Targeting.

fields

string

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.

filter

string

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

content_injection

boolean

This parameter enables the Personalized media in grid feature.

If true, the API response includes media objects along with product results.
The content and positions of the media objects are governed by the assets and media rules configured in the Bloomreach dashboard.

rows

int32

The number of matching items to return per results page in the API response. The maximum value is 200.
The result size is used from the Dashboard if it isn't sent in the API.

To enhance performance, limit this value to the number of items that you think is reasonable for a single page of search results.

view_id

string

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.