Patch Existing Rules

Patching rules will only change the rules that are specified in the request.

curl -X PUT -H "Content-Type: application/json" \
  -d '{
        "slot_rules": [
            {
                "rule": {
                    "item_id": "fiddos_food_item",
                    "position": 2
                },
                "active": true,
                "start_time": "2018-06-28 01:34:08",
                "end_time": "2018-06-30 01:34:08"
            }
        ]
    }' \
  -u"[your token]:" "https://ac.cnstrc.com/refined_filters/group_id/dog%20food?key=[your index key]&section=Products"

info

The above command returns a 204 Success response on success. For simplicity sake, a 204 Success response will be returned even if the item already exists.

HTTP Request#

PATCH https://ac.cnstrc.com/refined_filters/[filter_name]/[filter_value]?key=[your index key]&section=[section]

URL Parameters#

Parameter	Description
filter_name	The name of the facet you'd like to patch searchandizing rules for.
filter_value	The value of the facet you'd like to patch searchandizing rules for.
section	Yes	The index section you'd like to retrieve results from (typically `Products`).

JSON Specifications#

Example JSON:

{
  "slot_rules": [
    {
      "rule": {
        "item_id": "fiddos_food_item",
        "position": 1
      },
      "active": true,
      "start_time": "2018-06-28 01:34:08",
      "end_time": "2018-06-30 01:34:08"
    }
  ],
  "whitelist_rule": {
    "rule": {
      "filters": { "brand": ["fiddos food"] }
    },
    "end_time": "2018-06-28 01:34:08"
  },
  "blacklist_rules": [
    {
      "rule": {
        "filters": { "type": ["toys"] }
      },
      "start_time": "2018-06-28 01:34:08",
      "end_time": "2018-06-30 01:34:08"
    }
  ],
  "boost_rules": [
    {
      "rule": {
        "filters": { "color": ["red"] },
        "boost": 0.5
      }
    }
  ]
}

Types of rules#

id	Description
slot_rules	With slot rules, you can add an item to recall and pin it to a particular position. Provide `item_id` and a particular `position` for the item(s).
boost_rules	Boost or bury the score (and in turn, ranking) of matching items.
whitelist_rule	Restrict recall to only the matching items.
blacklist_rules	Remove matching items from recall.

Parameters#

Parameter	Required?	Description
rule	Yes	Rules can accept a dictionary of the various rule specs as show in the above JSON example.
active	No	Your slot rule can be defined but set to inactive if you wish by setting `active` field to false.
start_time	No	Start time of when the searchandizing rule should be enabled.
end_time	No	End time of when the searchandizing rule should be disabled.