Test rule evaluation

Simulate rule matching with user attributes

Test rule evaluation

POST /rules/redirect/:redirectId/test

Simulates rule evaluation by testing user attributes against all active rules for a redirect. Returns the matching rule and resulting destination URL without actually performing a redirect.

Path parameters

redirectId · string · required

The ID of the redirect whose rules to test

Request body

userAttributes · UserAttributes · required

User attribute values to test against rules

Show UserAttributes properties

country · string

Two-letter country code (e.g., “US”, “GB”)

region · string

State or region name

city · string

City name

device_type · string

Device category (e.g., “mobile”, “desktop”, “tablet”)

device_brand · string

Device manufacturer (e.g., “Apple”, “Samsung”)

device_model · string

Device model (e.g., “iPhone 14”, “Galaxy S23”)

browser_name · string

Browser name (e.g., “Chrome”, “Safari”, “Firefox”)

browser_version · string

Browser version

os_name · string

Operating system (e.g., “iOS”, “Android”, “Windows”)

os_version · string

OS version

referrer · string

Full referrer URL

referrer_domain · string

Referrer domain only

hour_of_day · number

Hour in 24-hour format (0-23)

day_of_week · number

Day of week (0=Sunday, 6=Saturday)

language · string

Language code (e.g., “en”, “es”, “fr”)

url_path · string

Request path

query_params · Record<string, string>

Query parameters as key-value pairs

user_agent · string

Raw user agent string

ip_address · string

Client IP address

Response

result · RuleEvaluationResult | null

The evaluation result, or null if no rules matched

Show RuleEvaluationResult properties

url · string

The destination URL that would be used

ruleId · number

ID of the matching rule

ruleName · string

Name of the matching rule

actionType · string

Type of action: “redirect”, “percentage_redirect”, or “ab_test”

percentage · number

For percentage redirects, the configured percentage

variant · string

For A/B tests, the selected variant name

triggered · boolean

Whether the rule was triggered

userAttributes · UserAttributes

The user attributes that were tested (echoed back)

message · string

Human-readable message about the test result

Examples

Test mobile device rule

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

const response = await testRuleEvaluation('redirect_123', {
  userAttributes: {
    device_type: 'mobile',
    country: 'US',
    browser_name: 'Safari',
    os_name: 'iOS'
  }
});

if (response.data.result) {
  console.log(`Matched rule: ${response.data.result.ruleName}`);
  console.log(`Destination: ${response.data.result.url}`);
  console.log(`Action type: ${response.data.result.actionType}`);
} else {
  console.log('No rules matched - would use default redirect');
}

Get rule analytics

GET /rules/redirect/:redirectId/analytics

Retrieve analytics and statistics for all rules associated with a redirect.

Path parameters

redirectId · string · required

The ID of the redirect

Response

analytics · RuleAnalyticsItem[]

Array of rule analytics

Show RuleAnalyticsItem properties

id · number

Rule ID

name · string

Rule name

type · RuleType

Rule type

status · RuleStatus

Current status

hitCount · number

Number of matches

percentage · string

Percentage of total hits

createdAt · string

Creation date

totalHits · number

Total hits across all rules

totalRules · number

Total number of rules

activeRules · number

Number of active rules

Example

Get rule analytics

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

const response = await getRuleAnalytics('redirect_123');
const { analytics, totalHits, totalRules, activeRules } = response.data;

console.log(`Total rules: ${totalRules}`);
console.log(`Active: ${activeRules}`);
console.log(`Total hits: ${totalHits}`);

console.log('\nRule performance:');
analytics.forEach(rule => {
  console.log(`${rule.name}: ${rule.hitCount} (${rule.percentage}%)`);
});

The test endpoint does not increment hit counts or affect analytics. It’s safe to call repeatedly for testing purposes.