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.

The Bloomreach-provided authentication key for the Bloomreach account that's sending the request.

Pass the auth_key with an empty value in client-side calls. The auth_key value is a private authorization key. If you include your valid auth_key value in client-side calls, then you inadvertently expose that private information to everybody.

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 the one account ID hosts multiple site versions with unique characteristics, such as language versions. Bloomreach uses your domain_key parameter value to ensure that only the data that pertains to that site version is used for query and analytics features, such as autosuggestions.

The example value shown here, documentation_site, 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.

The type of API request. Value should be search for Product Search or Category requests.

The type of search. Value should be keyword for Product Search requests, category for Category requests.

Indicates whether to return data wrapped in the function for cross-origin requests.

For server-side requests, use the value br_server. For native-app requests, use the value br_app.

Applies a complex boolean filter to search results to include or exclude items that fit your parameter values. Any product attribute in your product feed is valid, such as brand names and sizes.

Typically, the efq parameter is used for custom attributes that you include in your product feed to support additional business logic that you might need to filter. Read more about using the efq parameter in the "Complex boolean filtering" section in the Faceting and filtering page.

This parameter sends Product grid insights data in the API response to help debug your search results.
Allowed values are: all/recall/ranking/merchandising.

Refer to the guide Product grid insights on the API for more details, like the response format.

Return a count of ranged facets, such as price and sale price. Use numeric attributes only.

You need to parse the values that are in the facets_counts section of the response. The facet_queries section has custom range facets for numeric fields that you define in your request. The facet_fields section gives you facets that you can display to your site's users, such as brands and colors.

The attributes that you want returned in your API response, such as product IDs and prices.

All fl parameters for Product Search or Category requests must include pid as one of their values. Any attribute from your product feed may be used as a value for fl.

Multiple values should be comma separated, such as fl=pid,price.

The fq 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. Read more about using the fq parameter in the "Simple Filtering" section in the Faceting and filtering page.

You can configure Attributes from the Catalog Management Tab. Configure which attributes in your content feed you want to apply as filters to search results.

The latitude-longitude of the end-customer used for the Buy Online Pick-up In Store (BOPIS) feature.

Value should be provided as latitude,longitude. For example, ll=11.09,10.018.

Use fl=store_lat_lon to return the distance from ll. In the response body, this value is returned as an additional field with the suffix ‘.distance’.

Use fq=store_lat_lon to enable filtering by distance.

Your site visitor's search query. Search queries are composed of one or more terms.

For Category queries, the value is the category ID.

You can percent encode spaces between terms as %20, or you can leave the spaces unencoded.

If you use q=, the latency of the response will vary depending on your catalog size and it may not adhere to Bloomreach's standard SLA. Additionally, most merchandising operations do not work on query parameters, except for include/exclude operations.

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

An ID to track the API request for identification in logs.

Bloomreach doesn't automatically enforce the requirements for this parameter. For example, you can enter test as your value for each instance of the request_id parameter without triggering an error message. However, using a unique value (random number/Unix Timestamp) allows us to help you if you encounter a problem.

Sorts results based on the field value in ascending, descending, or another combination of orders. You can sort any fl field.

Value is a field name, followed by asc/desc for ascending/descending order, respectively. For example, sort=sale_price desc sorts in descending order of the sale price

This parameter allows you to display the maximum and minimum values of any numeric field in your data set for a user query. With this parameter, you can get all the documents matching a query and display the minimum and maximum values of single-valued, numeric attributes such as price, sale_price, length, width, reviews, etc.

Values are returned in the response as stats_field.

The absolute URL of the page where the request is initiated. Do not 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 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. In 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. If you do not track users this way, then omit this field.

A unique identifier for a specific view of your product catalog. If you have multiple versions of your site, each with their 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 widget_id provided in the Dashboard for the Dynamic Widgets feature, which is used to provided curated results.

This is an optional feature that can be enabled by discussing with your CSM.