Calling the Personalized Searc...
Auto-Suggestions

An AUTO_SUGGESTIONS request returns results—both suggested search terms and products—as the customer types each character in their search term. Therefore, a Personalized Search API call is made each time the customer types a new character. Personalized Search is both typo-tolerant and word order–toleratant, so it's able to return suggestions even when the customer misspells one or more words (for example, headlites instead of headlights) or puts the words of a search term in an unusual order (for example, chairs outdoor instead of outdoor chairs).
The recommended interval to wait between auto-suggestions request calls is 250 ms on key presses and 30 ms on focus.
POST
Request
Body Parameters
suggestions
required
Object
The set of parameters that define an auto-suggestions request.
Example Auto-Suggestions Request
{
  "searchToken": "monetate-156925593843210765",
  "suggestions": [
    {
      "id": "mySuggestionsQuery1",
      "typeOfQuery": "AUTO_SUGGESTIONS",
      "query": "shirt",
      "limit": 2
    },
    {
      "id": "mySuggestionsQuery2",
      "typeOfQuery": "AUTO_SUGGESTIONS",
      "query": "short",
      "limit": 3,
      "hlStartElem": "<span style='color:red'>",
      "hlEndElem": "</span>"
    }
  ]
}
{
  "searchToken": "monetate-156925593843210765",
  "suggestions": [
    {
      "id": "mySuggestionsQuery1",
      "typeOfQuery": "AUTO_SUGGESTIONS",
      "query": "shirt",
      "limit": 2
    },
    {
      "id": "mySuggestionsQuery2",
      "typeOfQuery": "AUTO_SUGGESTIONS",
      "query": "short",
      "limit": 3,
      "hlStartElem": "<span style='color:red'>",
      "hlEndElem": "</span>"
    }
  ]
}
Responses
200
{
  "suggestionResults": [
    {
      "id": "mySuggestionsQuery1",
      "suggestions": [
        {
          "suggest": "sweatshirt"
        },
        {
          "suggest": "street sweatshirt"
        }
      ]
    },
    {
      "id": "mySuggestionsQuery2",
      "suggestions": [
        {
          "suggest": "<span style='color:red'>short</span>"
        },
        {
          "suggest": "<span style='color:red'>short</span>s"
        },
        {
          "suggest": "<span style='color:red'>short</span>-sleeve"
        }
      ]
    }
  ]
}
{
  "suggestionResults": [
    {
      "id": "mySuggestionsQuery1",
      "suggestions": [
        {
          "suggest": "sweatshirt"
        },
        {
          "suggest": "street sweatshirt"
        }
      ]
    },
    {
      "id": "mySuggestionsQuery2",
      "suggestions": [
        {
          "suggest": "<span style='color:red'>short</span>"
        },
        {
          "suggest": "<span style='color:red'>short</span>s"
        },
        {
          "suggest": "<span style='color:red'>short</span>-sleeve"
        }
      ]
    }
  ]
}
﻿
Auto-Suggesting Products
In addition to suggesting search terms as the customer types, Personalized Search can suggest products within the auto-suggestions results. To use this function, add the recordQueries object to the request, with the value of its typeOfRequest parameter defined as "SEARCH". 
Here's an example of an auto-suggestions request to include products in the results:
Example Auto-Suggestions with Suggested Products Request
{
  "searchToken": "monetate-156925593843210765",
  "suggestions": [
    {
      "id": "autosuggestion",
      "query": "guitars",
      "typeOfRequest": "AUTO_SUGGESTIONS",
      "limit": 5
    }
  ],
  "recordQueries": [
    {
      "id": "productSearch",
      "typeOfRequest": "SEARCH",
      "settings": {
        "query": {
          "term": "guitars"
        },
        "limit": 5,
        "typeOfRecords": [
          "MONETATE_PRODUCT"
        ]
      }
    }
  ]
}
{
  "searchToken": "monetate-156925593843210765",
  "suggestions": [
    {
      "id": "autosuggestion",
      "query": "guitars",
      "typeOfRequest": "AUTO_SUGGESTIONS",
      "limit": 5
    }
  ],
  "recordQueries": [
    {
      "id": "productSearch",
      "typeOfRequest": "SEARCH",
      "settings": {
        "query": {
          "term": "guitars"
        },
        "limit": 5,
        "typeOfRecords": [
          "MONETATE_PRODUCT"
        ]
      }
    }
  ]
}
﻿
Refer to the recordQueries definition in Personalized Site Search Query Request﻿ for more information about its required and optional parameters.
Updated 17 Jan 2025
Calling the Personalized Search API
Personalized Site Search Queries