Improving product discovery with autocomplete suggestions and search insights

To deliver relevant search results to your store's shoppers, it's essential to understand how they search for products in your store. The Intelligent Search API offers powerful insights into popular search terms and autocomplete suggestions. The sections below outline how to use these tools to optimize your store's search experience.

Retrieving the most searched terms

To get your customers' most searched terms, use the Get list of the 10 most searched terms endpoint. This endpoint allows you to filter results by specifying a locale in the query parameters.

The response will return the most searched terms in order of popularity along with the number of searches:

{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAACCAIAAADwyuo0AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAI0lEQVR4nGMQkmFX01fat+/AoqULGPS1VdnZGb59+3bi6BEAbKsKkMH8G/4AAAAASUVORK5CYII=","img":{"src":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/consult-store-search-terms-information-0.png","width":1342,"height":640,"type":"png"}}

Response body example


_44{
_44  "searches": [
_44    {
_44      "term": "home",
_44      "count": 14
_44    },
_44    {
_44      "term": "shirt",
_44      "count": 10
_44    },
_44    {
_44      "term": "top",
_44      "count": 9
_44    },
_44    {
_44      "term": "tops",
_44      "count": 6
_44    },
_44    {
_44      "term": "camera",
_44      "count": 5
_44    },
_44    {
_44      "term": "kit",
_44      "count": 5
_44    },
_44    {
_44      "term": "work shirt",
_44      "count": 2
_44    },
_44    {
_44      "term": "shirts",
_44      "count": 2
_44    },
_44    {
_44      "term": "clothing",
_44      "count": 2
_44    },
_44    {
_44      "term": "classic shoes",
_44      "count": 1
_44    }
_44  ]
_44}

Retrieving autocomplete suggested terms and similar attributes

To gather data on autocomplete suggestions and similar attributes, use the Get list of suggested terms and attributes similar to the search term endpoint. You can refine the response by defining the locale and query parameters.

The response will return the searched terms by popularity order and the corresponding autocomplete suggestions for each term.

{"base64":" ","img":{"width":1358,"height":692,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":340366,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/consult-store-search-terms-information-1.png"}}

Response body example


_40{
_40  "searches": [
_40 {
_40   "term": "tv",
_40   "count": 28861,
_40   "attributes": [
_40     {
_40       "key": "departamento",
_40       "value": "tvs-e-video",
_40       "labelKey": "Departamento",
_40       "labelValue": "TVs e Vídeo"
_40     },
_40     {
_40       "key": "categoria",
_40       "value": "tvs",
_40       "labelKey": "Categoria",
_40       "labelValue": "TVs"
_40     },
_40     {
_40       "key": "subcategoria",
_40       "value": "receptor-de-controle-de-acesso",
_40       "labelKey": "Subcategoria",
_40       "labelValue": "Receptor de Controle de Acesso"
_40     }
_40   ]
_40 },
_40 {
_40   "term": "smarth tv",
_40   "count": 2308
_40 },
_40 {
_40   "term": "painel para tv",
_40   "count": 975
_40 },
_40 {
_40   "term": "rack tv",
_40   "count": 589
_40 }
_40  ]
_40}