Get banner list for a specific search

This guide uses Intelligent Search API v1. If you are migrating from Intelligent Search API (Legacy), see Migrating to Intelligent Search API v1.

It is possible to display banners as promotional actions on the customer’s search result page. This process is done through an association between the words and facets that represent filters selected when making a search. For more information on how to configure a banner, check the Configuring Banners article.

To retrieve a list of banners for a specific search, use the GET Get list of banners registered for query (v1) endpoint. You can filter the endpoint response by defining the search’s facets and the term’s locale and query.

Response body example:


_10{
_10  "banners": [
_10	{
_10  	"id": "summersale",
_10  	"name": "Summer Sale",
_10  	"area": "1",
_10  	"html": "<h1>This is a test</h1>"
_10	}
_10  ]
_10}