Applying redirects

Web admins can create keyword redirect rules in the Bloomreach Dashboard. If a keyword redirect rule applies to your search API request, then the response includes a keywordRedirect field.

original queryThe value of the request's q parameter.
redirected urlThe URL where your customer is redirected.
redirected queryThe query after Bloomreach processes the q parameter value. The redirect rule is executed on the redirected query value.

The redirected URL in search responses can be either a full URL or a relative path, depending on your integration requirements. Redirected URLs are configured in the Bloomreach Dashboard.


Review your logic

We strongly recommend that you review your logic to process the API response. If a keywordRedirect rule is present, it must execute before any other special event, such as a redirect to null results page when numFound is 0. This sequence allows your merchandising team to redirect search terms that otherwise return zero results to a better landing page than the null results page.

Example request and response

account_id=<Bloomreach Provided Account ID>
  "response": {
    "numFound": 1259,
    "start": 0,
    "docs": [
  "facet_counts": {
  "keywordRedirect": { //Redirect info
    "redirected url": "",
    "original query": "Store Hours",
    "redirected query": "stores"
  "category_map": {
  "sort_fields": [