List rules

Retrieve all rules for a redirect

Endpoint

GET /rules/redirect/:redirectId

Retrieves all rules associated with a specific redirect, ordered by priority (ascending).

Path parameters

redirectId · string · required

The ID of the redirect

Response

rules · Rule[]

Array of rule objects sorted by priority

Show Rule properties

id · number

Rule ID

redirectId · number

Parent redirect ID

name · string

Rule name

description · string

Rule description

type · RuleType

Rule type: force, percentage, or ab_experiment

priority · number

Evaluation priority (lower numbers evaluated first)

status · RuleStatus

Current status: active, inactive, or draft

conditions · RuleCondition[]

Array of conditions that must be met

Show RuleCondition properties

attribute · AttributeKey

User attribute to evaluate

operator · OperatorKey

Comparison operator

value · string | number | string[] | number[] | [number, number]

Value to compare against

param · string

Query parameter name (when attribute is query_param)

conditionLogic · ConditionLogic

How conditions are combined: AND or OR

action · RuleAction

Action to perform when rule matches

Show Action types

RedirectAction (type: force)

• type: “redirect”
• url: Destination URL

PercentageRedirectAction (type: percentage)

• type: “percentage_redirect”
• url: Destination URL
• percentage: Traffic percentage (0-100)

ABTestAction (type: ab_experiment)

• type: “ab_test”
• variants: Array of variants with name, percentage, and url

startDate · string

Optional start date (ISO 8601)

endDate · string

Optional end date (ISO 8601)

hitCount · number

Number of times this rule has matched

createdBy · string

User who created the rule

metadata · Record<string, string | number | boolean>

Custom metadata key-value pairs

createdAt · string

Creation timestamp (ISO 8601)

updatedAt · string

Last update timestamp (ISO 8601)

Examples

Get all rules

import { getRulesForRedirect } from '@quickleap/sdk';

const response = await getRulesForRedirect('redirect_123');
const rules = response.data.rules;

console.log(`Found ${rules.length} rules`);
rules.forEach(rule => {
  console.log(`${rule.priority}: ${rule.name} (${rule.status})`);
});

Get rule by ID

To retrieve a single rule by its ID:

GET /rules/:ruleId

Path parameters

ruleId · string · required

The ID of the rule

Response

rule · Rule

The rule object (same structure as above)

Example

Get single rule

import { getRuleById } from '@quickleap/sdk';

const response = await getRuleById('rule_456');
const rule = response.data.rule;

console.log(`Rule: ${rule.name}`);
console.log(`Status: ${rule.status}`);
console.log(`Priority: ${rule.priority}`);
console.log(`Hit count: ${rule.hitCount}`);

Rules are always returned sorted by priority in ascending order. The first rule in the array has the highest priority and will be evaluated first.