GetSearchTuningRule

Retrieves the details of the specified search tuning rule.

Request

HTTP Request

GET
 api/commerce/catalog/admin/search/searchtuningrules%2f%7bsearchTuningRuleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Parameters

Parameter NameDescription
Parameters
searchTuningRuleCodetype: string 

The unique identifier of the search tuning rule.

responseFieldstype: string 

Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.

Required Behaviors

  • Read Product Ranking Definition

Request Properties

No request body content

Response Properties

The details of the specified search tuning rule.

PropertyDescription
active

type: bool

Specifies whether the search results tuning rule is active.

activeEndDate

type: DateTime

The date that the search tuning rule is no longer active.

activeStartDate

type: DateTime

The date the search tuning rule starts being active.

auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

blockedProductCodes

type: list of string

A list of product codes that you wish to block from appearing on a search result, or on a specific category page. Use the filters field to specify a category page.

boostedProductCodes

type: list of string

A list of product codes that you wish to explicitly boost using the search tuning rule.

Note: The order that you list products in defines the order that they appear in a search result, or category page.

filters

type: list of searchTuningRuleFilter

The filters that limit what the search tuning rule is applied to. Currently, the only supported filters are category pages.

For example, you can limit the search tuning rule to only apply when a shopper either navigates to or searches for a specific keyword on a category page.

searchTuningRuleFilter.field

type: string

A property that is a wrapper for additional properties pertaining to the schema such as the type, label, any associated data, an ID, and the order of the response.

searchTuningRuleFilter.value

type: string

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

isDefault

type: bool

Indicates if the object is default. This indicator is used for product variations and site search settings. If true, the value/object is the default option.

keywords

type: list of string

The keywords that trigger the search tuning rule. These are specific keywords that shoppers search for.

searchTuningRuleCode

type: string

The unique identifier of the search tuning rule.

searchTuningRuleDescription

type: string

The description of the search tuning rule. Use this field for further identification purposes.

searchTuningRuleName

type: string

The name of the search tuning rule. Use this field for further identification purposes.

siteId

type: int

Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.

Response Body