Sign in

v1

latestOpenAPI 3.0.02026-07-26221117272.0 KB
SearchV2

Search

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

post/api/v2/search

Request body

IndexNamestring

Search a given index

Querystring

Custom search query

DistanceUnitType1 | 2 | 3

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

RequestType0 | 1 | 2 | 3 | 4 | 5 | 6

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

ImageDatastring

Base64 encoded image

ImageTextstring

Optional additional text description of an image

kValueinteger

Optional additional text description of an image

FacetHierarchyLevelOverrideobject

Facet Hierarchy Level Override

NestedIdstring

Nested Id

ClientGuidstring

API Client Guid

Keywordstring

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

PageIdinteger
PageNointeger

Current page number

MaxPerPageinteger

Max number of elements on a page

SearchWithinstring
SortBystring

Sort by a filed name

SortingSetCodestring

Set sorting set evaluation override

PaginationSetCodestring

Set pagination set evaluation override

FacetSelectionsobject

Selected facets names with values

CustomUrlstring

Landing page Custom URL

IsInPreviewboolean

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

Is100CoverageTurnedOnboolean

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

ExplainDocIdstring

Explain document id

FacetOverridestring[]

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

FieldOverridestring[]

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

SearchTypestring

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

IgnoreSpellcheckboolean

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

Example request

{
  "ClientData": {
    "VisitorId": "00000000-0000-0000-0000-000000000000",
    "VisitId": "00000000-0000-0000-0000-000000000000"
  }
}

Response

OK

object required