Autocomplete Search Suggestions API

Overview

Use the Autocomplete Search Suggestions API to retrieve the search suggestion terms stored in the dashboard. These terms appear in the search input field as part of the placeholder text.

The terms rotate according to the duration and number of words set by the admin in the Athena Dashboard’s Search Suggestions Settings, under Setting -> Autocomplete.

Endpoint

Method	Path
`POST`	`/api/v1/search-suggestions`
`POST`	`/api/v2/search-suggestions`

Request body

JSON

{
   "token": "{{ website_token }}" //required
}

Successful response

JSON

{
   "enabled_disabled": "off",
   "placeholder_text": "Search for ..",
   "rotation_in_seconds": "5",
   "suggestions_keywords": [
      {
         "content": "keyword1"
      },
      {
         "content": "keyword2"
      },
      {
         "content": "keyword3"
      },
      {
         "content": "keyword4"
      },
      {
         "content": "this is  another keyword"
      },
      {
         "content": "lorem ipsum lorem ipsum lorem ipsum keyword"
      }
   ]
}