Use Case Dependent Parameters

callback

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

If you're running a server-side request, then use the value, br_server. If you're running a native-app request, then use the value, br_app.

Value type

string (enum)

Example value

Use case

Return data wrapped in the function for cross-origin requests.

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. 

Value type

string

Example value

Use case

Apply filtering to search results.

Specify a particular type of non-product content.

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.

Value type

String

Example value

Use case

Apply complex filtering to search results.

facet.range

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

Value type

string

Example value

Use case

Apply ranged filtering to search results.

sort

Sorts results based on the field value in ascending, descending, or another combination of orders. You can sort any fl field. Some examples are given below:

• sale_price desc sorts in descending order of the sale price

• sale_price asc sorts in ascending order of the sale price

• price desc sorts in descending order of the price

• price asc sorts in ascending order of the price

• launch_date desc sorts in descending order of the date on which products launched

• launch_date asc sorts in ascending order of the date on which products launched

• low_price sorts based on the lowest SKU price

• low_sale_price sorts based on the SKU’s lowest sale price

Value type

string (enum)

Example value

Use case

Sort search results by certain attributes

view_id

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. For example, Abacus Thinking sells different academic products to different grade levels. A first grade teacher looks in their Kindergarten through Grade 3 catalog, which Abacus Thinking assigns the ID, k-3:

💡Consistent, valid values

Your view_id values must be the same in your API, pixel, and product catalog. If Abacus Thinking assigns the value, ACA-MAX, to the view_id parameter in their product feed, then the parameter value, academia maximiliano, doesn't match any catalog view.

Value type

string

Example value

Use case

Search a specific view of a site with multiple versions.

user_id

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.

Value type

string

Example value

Use case

Track individual site visitor behavior.

widget_id

This widget_id is provided via the brSM dashboard under "Dynamic Widgets" to fulfill certain usecases where the results need to be independently curated by business users. This is an optional feature that can be enabled by discussing with your CSM.

Example

Use case

Retrieve a specific Dynamic Widget based result set using a widget_id

stats.field

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 specific attributes such as price, sale_price, length, width, reviews, and so on.

Note : This parameter is supported for single-valued numeric attributes only.

Example

&stats.field=sale_price,price,MARGIN_DOLLAR

Sample Response

{
"response": ...
"facet_counts:" ...
"stats":{  
   "stats_field":{  
      "sale_price":{  
         "max":2449.99,
         "min":0.69
      },
      "price":{  
         "max":2449.99,
         "min":0.69
      },
      "MARGIN_VALUE":{  
         "max":0.91,
         "min":0
}
}

Note: The API response returns this as "stats_field".

Use case

The stats.field parameter can be used to display the price range (max-min) in the UI as a price slider. When the user performs a search query, the maximum and minimum price of the queried product is displayed with stats.field. This parameter can also be used for other numeric attributes such as review, length, width, and so on. 

The latitude-longitude of the end-customer in format lat,long separated by a comma.

Value Type

Alpha-numeric string

Required

Mandatory

Example value

lat,lon  eg. 11.09,10.018

Returns the distance from point “ll”. In the response body, this value is returned as an additional field with the suffix ‘.distance’.

Value Type

Sting

Required

Mandatory 

Example value

fl=geo_spatial_field

You can send this value if you want to enable filtering by distance. This distance is calculated with reference to “ll”.

Value Type

String

Required

Optional

Example value

fq=geo_spatial_field : “100”