API Explorer

API Explorer lets you explore Bloomreach APIs interactively and in real-time and can help you ensure that Bloomreach personalization APIs are returning results as expected.

How to Navigate to API Explorer

To access the API Explorer,

  • Log in to the Bloomreach Dashboard.
  • Go to Gearbox > DevStudio > API > API Explorer.
752752

Bloomreach Search and Merchandising UI

UI Fields

Options

Domain

Select the Domain

Environment

Select the environment in which you want to interact with Bloomreach APIs

  • Staging
  • Production

Select API

Select the API you would like to interact with:

  • Product search API
  • Category API
  • Autosuggest API

Select Endpoint

Select the BloomReach Endpoint

Query (q)

  • Product search API:
  • Category API: <category_name> OR <category_id>

Product Attributes (fl)
SKU Attributes (fl)

Select attributes that you would like to display in API response

Facet Range
Filters (fq)
Filters (efq)

Select which filters you would like to apply in your API request

Sort

Select how to sort results based on your field value.

  • ascending
  • descending

Run Query

It executes the API call

The user interface looks like below:

16001600

Search and Merchandising APIs

Currently, three types of APIs are available and we are working to support more APIs over time.

  • 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.

Product search API

To access the Product search API, log in to the Bloomreach Dashboard.

  • Go to DevStudio > API > API Explorer.
  • Select API -> Product Search API
  • Select the required UI parts from the drop-down menus
  • Query (q) = ▶️Run Query
925925

Category API

To access the Product search API, log in to the Bloomreach Dashboard.

  • Find the category_Id or category_name:
    1. Search & Merchandising > Categories > All category pages
    2. Copy the category ID or category name
16001600
  • Go to DevStudio > API > API Explorer.
  • Select API -> Product Search API
  • Query (q) = <category_id> OR <category_name> ▶️Run Query
925925

Autosuggest API

To access the Product search API,

  • Log in to the Bloomreach Dashboard.
  • Select API -> Autosuggest API
  • Query (q) = ▶️Run Query
16001600

Did this page help you?