Autocomplete

post

https://searchapi-dev.hawksearch.net/api/v2/autocomplete

The Autocomplete method is to be called when users have typed part of the keyword. The endpoint returns suggestions from HawkSearch.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Autocomplete params

FacetSelections

object

Selected facets names with values

CustomUrl

string

Landing page Custom URL

SortBy

string

Sort by a filed name

SortingSetCode

string

Set sorting set evaluation override

PageId

int32

NestedId

string

Nested Id

ClientGuid

string

API Client Guid

Keyword

string

Search term. If term isn’t included we search everything

IsInPreview

boolean

Flag set to true will display elements in a preview mode. Flag set to false will display live data

Type

int32

enum

To control the ability of returning numbers of rows from Elastic Search, both ‘Type’ and ‘ProductCount’ parameters needs to be set
e.g.: Type=Category, ProductCount=2. Search response will return max 2 items for category suggestions.

Allowed:

ProductCount

int32

The maximum number of results to return for selected ‘Type’ (see above)

DisplayFullResponse

boolean

Flag set to true will display also full Document object from Elastic for Products and Content suggestions

FieldOverride

array of strings

An array of field names that Elastic Search will return in a response

FieldOverride

SmartBar

object

Smart Bar turns On/Off:
'Boost and Bury', 'Visibility Rules', 'Presonalized Boost', 'Popularity Boost', 'Item Pin Processor' , 'KeywordReplacement'

ClientData

object

IndexName

string

Search a given index

Query

string

Custom search query

BoostQueries

array of objects

BoostQueries

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

200OK