Search

post

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

The Search method is used to retrieve search results or to retrieve the contents for a Landing Page . Either the Keyword or CustomUrl parameter should be included anytime this method is used. The following are use-cases for when this method should be used.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Search Request Body

IndexName

string

Search a given index

Query

string

Custom search query

Variant

object

BoostQueries

array of objects

BoostQueries

DistanceUnitType

int32

enum

Defines type of distance unit; Miles [1], Meters [2], Kilometers [3]
Default value is set to Miles [1]

Allowed:

RequestType

int32

enum

Defines the type of search being performed.
DefaultSearch is teh keyword or landing page request.

Allowed:

ImageData

string

Base64 encoded image

ImageText

string

Optional additional text description of an image

kValue

int32

Optional additional text description of an image

FacetHierarchyLevelOverride

object

Facet Hierarchy Level Override

NestedId

string

Nested Id

ClientGuid

string

API Client Guid

Keyword

string

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

PageId

int32

PageNo

int32

Current page number

MaxPerPage

int32

Max number of elements on a page

SearchWithin

string

SortBy

string

Sort by a filed name

SortingSetCode

string

Set sorting set evaluation override

PaginationSetCode

string

Set pagination set evaluation override

FacetSelections

object

Selected facets names with values

CustomUrl

string

Landing page Custom URL

IsInPreview

boolean

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

Is100CoverageTurnedOn

boolean

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

ExplainDocId

string

Explain document id

FacetOverride

array of strings

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

FacetOverride

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

SearchType

string

Defines type of search; RegularSearch [1] or RefineSearch [2]

IgnoreSpellcheck

boolean

If flag is set, spellcheck is being ignored, original keyword is used for query

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