Documentation Index Fetch the complete documentation index at: https://mintlify.com/dishant0406/quickleap/llms.txt
Use this file to discover all available pages before exploring further.
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
The ID of the redirect whose rules to test
Request body
User attribute values to test against rules Show UserAttributes properties
Two-letter country code (e.g., “US”, “GB”)
Device category (e.g., “mobile”, “desktop”, “tablet”)
Device manufacturer (e.g., “Apple”, “Samsung”)
Device model (e.g., “iPhone 14”, “Galaxy S23”)
Browser name (e.g., “Chrome”, “Safari”, “Firefox”)
Operating system (e.g., “iOS”, “Android”, “Windows”)
Hour in 24-hour format (0-23)
Day of week (0=Sunday, 6=Saturday)
Language code (e.g., “en”, “es”, “fr”)
Query parameters as key-value pairs
Response
result
RuleEvaluationResult | null
The evaluation result, or null if no rules matched Show RuleEvaluationResult properties
The destination URL that would be used
Name of the matching rule
Type of action: “redirect”, “percentage_redirect”, or “ab_test”
For percentage redirects, the configured percentage
For A/B tests, the selected variant name
Whether the rule was triggered
The user attributes that were tested (echoed back)
Human-readable message about the test result
Examples
Test mobile device rule
Test geographic targeting
Test query parameter rule
Test A/B experiment
Test time-based rule
Batch test multiple scenarios
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
Response
Array of rule analytics Show RuleAnalyticsItem properties
Total hits across all rules
Example
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 ( ' \n Rule 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.