Retrieve searchabilities (Deprecated)

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

sectionstring

The section of the index to use. Defaults to Products.

Example:Products

namestring

Name of searchability field.

fuzzy_searchableboolean

Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.

exact_searchableboolean

Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.

displayableboolean

Specifies whether the field is displayable in the response within the results array.

{
  "name": "brand",
  "fuzzy_searchable": true,
  "displayable": true
}

num_results_per_pageinteger

The number of results per page to return.

Example:20

pageinteger

The page of results to return.

Example:1

offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

sort_by'name' | 'percentage_presence'

The criteria by which searchability configurations should be sorted.

Example:name

sort_order'ascending' | 'descending'

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

namestring

Name of searchability field.

fuzzy_searchableboolean

Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.

exact_searchableboolean

Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.

displayableboolean

Specifies whether the field is displayable in the response within the results array.

{
  "name": "brand",
  "fuzzy_searchable": true,
  "displayable": true
}

namestring

Name of searchability field.

fuzzy_searchableboolean

Configure a field as fuzzy-searchable to enable typo-tolerant keyword-matching on field values in search and autocomplete. A field can be fuzzy-searchable or exact-searchable, but not both. Avoid marking very verbose fields (e.g. long descriptions) as fuzzy-searchable, since it can lead to recall of more items than is necessary and introduces complexity with ranking.

exact_searchableboolean

Configure this field for ID or ID-like values (SKU ID, ISBN, part number, etc.) to enable exact matching only, with no typo-tolerance, for search and autocomplete. Do not use for fields containing natural language words. A field can be exact-searchable or fuzzy-searchable, but not both.

displayableboolean

Specifies whether the field is displayable in the response within the results array.

{
  "name": "brand",
  "fuzzy_searchable": true,
  "displayable": true
}

search_configurableboolean

Filter only configurable searchabilities.

Example:true

v1

Query parameters

Response