Skip to main content
GET
/
commerce
/
catalog
/
admin
/
search
/
{name}
/
sitesearchsettings
Error
A valid request URL is required to generate request examples
{
  "sowBehavior": 123,
  "searchMode": 123,
  "vectorSettings": {
    "topK": 123,
    "hybridMode": 123,
    "thresholdDistance": 123,
    "filterByThresholdDistance": true,
    "multiplier": 123,
    "applyBoostFunctions": true
  },
  "fieldWeights": [
    {
      "searchFieldName": "<string>",
      "weight": 123,
      "phraseWeight": 123
    }
  ],
  "customBoosts": [
    "<string>"
  ],
  "fieldValueBoost": {
    "boostType": "<string>",
    "fields": [
      {
        "fieldName": "<string>",
        "valueExpressions": [
          {
            "value": "<string>",
            "boost": 123,
            "operator": "<string>"
          }
        ]
      }
    ]
  },
  "multiTermSynMinimumMatchPercents": [
    123
  ],
  "minimumMatchPercents": [
    123
  ],
  "phraseSlop": 123,
  "twoWordPhraseBoost": true,
  "personalizationExperience": "<string>",
  "personalizationFactor": 123,
  "searchChildProductsByDefault": true,
  "crossFieldAdditiveScoreFactor": 123,
  "typoTolerance": {
    "factor": 123,
    "distance": 123,
    "enabled": true
  },
  "spellcheck": {
    "autocorrect": true,
    "didyoumean": true,
    "spellcheckEnabled": true
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

name
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

sowBehavior
integer<int32> | null

controls sowBehavior (Never=0, Always=1, WhenNoMultiTermSyn=2) never sow=false, always sow=true, WhenNoMultiTermSyn = (depends on existance of multitermsynonym match in query)

searchMode
integer<int32> | null
vectorSettings
object
fieldWeights
object[] | null
customBoosts
string[] | null
fieldValueBoost
object
multiTermSynMinimumMatchPercents
integer<int32>[] | null

if values present is used for mm when sowBehavior.WhenNoMultiTermSyn and multi term sym match found in query if no values are present or null fallback to MinMatchPercents

minimumMatchPercents
integer<int32>[] | null
phraseSlop
integer<int32>
twoWordPhraseBoost
boolean | null

if true, 2 word shingles used for phrase boosting based on fields with phrase weights greater than 0 if false, only full phrase mathing used for phrase boosting

personalizationExperience
string | null
personalizationFactor
number<double> | null
searchChildProductsByDefault
boolean
crossFieldAdditiveScoreFactor
number<double>
typoTolerance
object
spellcheck
object