Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Searchabilities

Retrieve searchability (Deprecated)

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: searchabilities(r).

Retrieve searchability with specified name.

get/v1/searchabilities/{name}

Path parameters

namestring required

Query parameters

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
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

Response

OK

namestring required

Name of searchability field.

percentage_presencenumber

Percentage of items and variations that contain this field.

fuzzy_searchableboolean required

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.

facetableboolean required

Specifies whether the field should be treated as a facet. When True, the metadata field must be a string, float, integer, or list of these types. Dictionaries are supported if they contain values of these types. Nested dictionaries are not supported

exact_searchableboolean required

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.

type'number' | 'string' | 'array' | 'object' | 'boolean' | 'mixed'
example_itemsstring[]

A list of items that has this searchability field.

defaultboolean required

Flag that shows if this searchability config is default.

displayableboolean required

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

hiddenboolean required

Hides the field by default in the response but makes it available to retrieve via fmt_options[hidden_fields] parameter.

created_atstring date-time required

Creation date and time

updated_atstring date-time

Last updated date and time