Creating a rule
- Navigate to Console > Ranking > Rules Engine.
- Click New Rule.
- Fill in the required fields:
- Name — a descriptive label (e.g. “Pin new series to top 3”).
- Type — the kind of action the rule performs (see below).
- Priority — higher numbers execute first. Use priority to control which rules take precedence.
- Active — toggle on to make the rule live.
- Add conditions to control when the rule applies.
- Configure the action parameters.
- Optionally set a schedule (start and end dates).
- Click Create Rule.
Rule types
| Type | What it does | Example use |
|---|---|---|
boost | Multiply an item’s score by a factor | Promote seasonal content |
bury | Reduce an item’s score by a factor | Demote low-quality items |
pin | Lock an item into a specific position | Feature a new release at position 1 |
filter | Remove items that match conditions | Hide out-of-stock products |
diversify | Ensure variety across a metadata field | No more than 3 items from the same category |
slot | Reserve positions for items matching criteria | Always show one editorial pick in the top 5 |
Conditions
Conditions determine which items or users a rule applies to. A rule with no conditions applies to all items for all users.Item metadata conditions
Match against fields in the item’s metadata:| Field | Operator | Value | Meaning |
|---|---|---|---|
genre | equals | action | Item genre is “action” |
price | greater_than | 50 | Item costs more than 50 |
stock_status | equals | out_of_stock | Item is out of stock |
Segment conditions
Target a rule to users in a specific segment:- Add a condition and set the field to
segment_id. - A dropdown appears listing all available segments.
- Select the segment. The rule now only applies to users who belong to that segment.
Scheduling
Rules support time-based activation via start and end dates.| Configuration | Behaviour |
|---|---|
| Both dates set | Rule is active only within the window |
| Start date only | Rule activates at that time, no automatic end |
| End date only | Rule is active now but deactivates after the deadline |
| Neither date set | Rule is always active (subject to the Active toggle) |
Setting a schedule
- In the rule editor, use the Start date and End date datetime pickers.
- Rules with a schedule show a scheduled badge in the table view.
- Click Clear schedule to remove dates and make the rule always-active.
Priority and execution order
Rules execute in descending priority order (highest first). When multiple rules affect the same item:- A
pinat priority 100 places the item before aboostat priority 50 can change its score. - A
filterat any priority removes the item entirely, so later rules never see it.
- 100+ for hard business constraints (compliance, filtering)
- 50-99 for campaign promotions
- 1-49 for soft merchandising preferences
How rules interact with experiments
When an A/B experiment is running, each variant can includeconfig_overrides that specify:
include_rule_ids— only these rules apply for users in this variantexclude_rule_ids— these rules are skipped for users in this variant

