API Explorer - Bloomreach Experience - Open Source CMS

API Explorer

API Explorer lets you explore Bloomreach APIs interactively and in real time.   

It lets you quickly answer the questions:

  • Are my APIs returning expected results?
  • Are my API calls setup correctly?

During the integration, API Explorer helps you go through examples of what the API request should look like given specific parameter selections as well as understand if your feed is setup correctly to ensure expected results from Bloomreach APIs.

Post integration, API Explorer can help you ensure that Bloomreach personalization APIs are returning results as expected.

How to Navigate to API Explorer

To access the API Explorer,

  1. Log in to the Bloomreach Dashboard.
  2. Go to DevStudio > API > API Explorer.

Supported APIs

API Explorer supports the following Bloomreach Search and Merchandising feature APIs:

  • Product search API for retrieving product search results.
  • Category API for retrieving search results within categories of items.
  • Autosuggest API for suggesting queries, categories, and products while your site visitor enters a search query.

The supported APIs are available via the "Select API" dropdown in API Explorer. We are working to support more APIs over time.

Supported Data Formats

API Explorer currently supports JSON for API request and response payloads. 

Parts of API Explorer

To help you get the most out of using Bloomreach's API Explorer, here is a summary of the user interface. 

User Interface Part Description
1 This drop down will allow you to pick the environment in which you want to interact with Bloomreach APIs. You can interact with Bloomreach APIs in either the staging or production environment.
2 The "Select API" dropdown will allow you to pick which API you would like to interact with.
3 The "Select Endpoint" dropdown will allow you to pick which endpoint your API is configured on.
4

API Explorer automatically lists all required parameters for the selected API as well as values available for the parameters. You can select values for parameters to construct your API request.

5 The fq parameters apply a faceted filter to the returned products, searching for products that fit your parameter values. Using these dropdowns, you can select which filters you would like to apply in your API request.
6 Using the primary and secondary sort options, you can select how to sort results based on your field value. Sorts can be done in ascending or descending order.
7
Once you have setup the parameters for your API request, clicking on "Run Query" will execute the API call.
8
This section shows the API request that have been made via API Explorer. The API request are listed in chronological order.
9
This section shows the API response for the selected API request. This section will get updated as a new request is made.

Debugging missing parameter values

As you use API explorer, you may find missing parameter value such as:

  • A missing product or SKU attribute
  • A missing facet range
  • A missing filter
  • A missing sort option

Please see below on how to debug these missing values. 

A missing product or SKU attribute

If a product attribute or SKU attribute is missing, it is because this attribute has not been configured in your Bloomreach feed. Please reach out to your Bloomreach representative or the Bloomreach support team to ensure that this specific attribute has been configured in feed setup to be "Included in Search API response".  

To learn more about how fl parameters are used, please take a look our Search and Merchandising feature API documentation. 

A missing facet range

The facet range parameter allows for a return count of ranged facets, such as price and sale price. If you are missing a facet range, it is because this attribute in your feed has not been configured to be a numeric attribute. Please reach out to your Bloomreach Technical Project Manager or the Bloomreach support team to ensure that this specific attribute has been configured to have "Value type = Number".

To learn more about how facet range parameters are used, please take a look our Search and Merchandising feature API documentation. 

A missing filter

The fq parameter applies a faceted filter to the returned products. Any facet that you want to filter must be in your product feed. If you are missing a filter value, it is because this attribute has not been configured to be facetable in your Bloomreach feed. Please reach out to your Bloomreach Technical Project Manager or the Bloomreach support team to ensure that this specific value has been configured to "Is facetable".

To learn more about how to use filters, please take a look our  Search and Merchansiging feature API documentation. 

A missing sort option

If you are missing a sort filter value, it is because this attribute has not been configured to be sortable in your Bloomreach feed setup.  Please reach out to your Bloomreach Technical Project Manager or the Bloomreach support team to ensure that this specific value has been configured to "Field Type = Single".

To learn more about how to use sort, please take a look our Search and Merchandising feature API documentation. 

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?