Script Rule

​

When to Use Script Rule

• Complex conditional logic - Multiple conditions combined with AND/OR operators
• Geolocation-based routing - Direct visitors based on country, region, ISP, or connection type
• Behavior-based decisions - Route based on visit frequency, time between visits, or browsing patterns
• Customer segmentation - Different flows for existing customers vs new visitors
• Anti-fraud protection - Detect suspicious patterns like rapid page visits or VPN usage
• Device/Platform targeting - Advanced device detection beyond simple mobile/tablet/desktop
• Tag-based routing - Check for multiple tags with complex logic
• Click attribution - Route based on traffic source, click age, or IP matching

​

How Script Rules Work

1. Server-Side Execution: Script Rules run on the server before the page loads
2. Return Boolean: Your script must return true or false
3. Flow Control:
   • true → Takes the Yes (left/top) path
   • false → Takes the No (right/bottom) path
4. Available Data: You have access to pre-loaded visitor data (see below)

​

Available Data Variables

​

Core Variables

​

is_whitelisted

// Route whitelisted visitors differently
return is_whitelisted === true;

​

whitelist_source

// Only allow domain-level whitelist
return whitelist_source === 'domain_all_whitelisted';

​

query

// Check multiple query parameters
return query.source === 'facebook' && query.campaign === 'spring2024';

// Check if parameter exists
return query.hasOwnProperty('affiliate_id');

​

ip_address

// Block specific IP range
return !ip_address.startsWith('192.168.');

​

ip_address6

// Allow only IPv6 traffic
return ip_address6 !== '' && ip_address6 !== null;

​

referer / referrer

// Check traffic source
return referer.includes('google.com') || referer.includes('facebook.com');

// Direct traffic only
return referer === '' || referer === null;

​

merchant_code

// Route based on merchant
return merchant_code === 'buygoods';

​

Device Information

​

is_mobile

// Mobile-only offers
return is_mobile === true;

​

is_tablet

// Exclude tablets from mobile offers
return is_mobile === true && is_tablet === false;

​

device

• device.type - Device type (e.g., ‘smartphone’, ‘tablet’, ‘desktop’)
• device.brand - Device brand (e.g., ‘Apple’, ‘Samsung’, ‘Google’)
• device.model - Device model
• device.os - Operating system
• device.os_version - OS version
• device.browser - Browser name
• device.browser_version - Browser version

// Target specific platforms
return device.os === 'iOS' && device.brand === 'Apple';

// Exclude old browsers
return device.browser !== 'Internet Explorer';

// Check OS version
return device.os === 'Android' && parseInt(device.os_version) >= 10;

​

Customer Data

​

is_customer

// Existing customers only
return is_customer === true;

// New visitors only
return is_customer === false;

​

is_test_customer

// Exclude test purchases
return is_customer === true && is_test_customer === false;

​

customer

• customer.name - Customer name
• customer.email - Customer email
• customer.phone - Customer phone
• customer.country - Customer country
• customer.zip - Postal code
• customer.city - City
• customer.address - Street address
• customer.order_id - Last order ID
• customer.order_item - Last purchased product code
• customer.order_item_name - Last purchased product name
• customer.order_ids - Array of all order IDs
• customer.is_test - Whether it’s a test order

// Target customers from specific country
return is_customer && customer.country === 'US';

// Check if they bought specific product
return customer.order_item === 'product-123';

// Multiple purchases
return customer.order_ids && customer.order_ids.length > 1;

​

Session & Tracking

​

session.aff_id

// Specific affiliate only
return session.aff_id === 'affiliate-001';

// Any affiliate traffic
return session.aff_id !== null && session.aff_id !== '';

​

time / utc_timestamp

// Check time of day (convert to hours)
const hour = new Date(time).getUTCHours();
return hour >= 9 && hour <= 17; // Business hours UTC

// Time-based routing
const now = new Date(utc_timestamp);
return now.getUTCDay() === 0 || now.getUTCDay() === 6; // Weekends

​

Tags

​

tags

// Check if visitor has specific tag
return tags.includes('vip_customer');

// Check multiple tags
return tags.includes('viewed_vsl') && tags.includes('clicked_cta');

// Has any tags
return tags.length > 0;

​

IP Geolocation Data (Advanced)

​

ip_whois

• ip_whois.country - Country code (e.g., ‘US’, ‘GB’, ‘DE’)
• ip_whois.country_name - Full country name
• ip_whois.region - Region/state code
• ip_whois.region_name - Full region name
• ip_whois.city - City name
• ip_whois.zip - Postal code
• ip_whois.lat - Latitude
• ip_whois.lon - Longitude
• ip_whois.timezone - Timezone (e.g., ‘America/New_York’)
• ip_whois.isp - Internet Service Provider
• ip_whois.org - Organization
• ip_whois.as - Autonomous System number
• ip_whois.asname - AS name
• ip_whois.mobile - Is mobile carrier
• ip_whois.proxy - Is proxy detected
• ip_whois.hosting - Is hosting provider
• ip_whois.is_government - Is government IP
• ip_whois.is_bot - Is known bot

// Target specific countries
return ip_whois.country === 'US' || ip_whois.country === 'CA';

// Block certain regions
return ip_whois.country !== 'CN' && ip_whois.country !== 'RU';

// Block VPNs and proxies
return ip_whois.proxy !== true && ip_whois.hosting !== true;

// Government/enterprise IPs
return ip_whois.is_government === true;

// Block bots
return ip_whois.is_bot !== true;

// ISP-based routing
return ip_whois.isp.includes('Comcast') || ip_whois.isp.includes('Verizon');

// Mobile carrier traffic
return ip_whois.mobile === true;

​

Click Data (Advanced)

​

click_data

• click_data.time - Click timestamp (Unix seconds)
• click_data.seconds_ago - Seconds since click
• click_data.ip_address - Click IP address (IPv4)
• click_data.ip_address6 - Click IP address (IPv6)
• click_data.ip_address_matches - Does current IP match click IP

// Click must be recent (within 1 hour)
return click_data.seconds_ago < 3600;

// IP must match original click
return click_data.ip_address_matches === true;

// Old clicks only
return click_data.seconds_ago > 86400; // Over 24 hours

// Combined check
return click_data.ip_address_matches && click_data.seconds_ago < 1800; // Same IP within 30min

​

Visit Data (Advanced)

​

visit_data

• visit_data.first_visit - First visit timestamp
• visit_data.time_since_first_visit - Milliseconds since first visit
• visit_data.visit_count - Total number of visits
• visit_data.last_visit - Last visit timestamp
• visit_data.time_since_last_visit - Milliseconds since last visit
• visit_data.ip_address - First visit IP (IPv4)
• visit_data.ip_address6 - First visit IP (IPv6)
• visit_data.session_id - First session ID
• visit_data.has_multiple_user_agents - Used different browsers/devices
• visit_data.unique_user_agent_count - Number of different user agents
• visit_data.page_visit_count_30min - Page visits in last 30 minutes
• visit_data.page_visit_count_all_time - Total page visits ever
• visit_data.unique_pages_visited - Number of different pages visited
• visit_data.average_time_between_visits - Average time between visits (ms)
• visit_data.direct_visits_count - Visits without referrer
• visit_data.referrer_visits_count - Visits with referrer
• visit_data.rapid_visits_detected - Suspicious rapid visiting pattern

// First-time visitors only
return visit_data.visit_count === 1;

// Returning visitors
return visit_data.visit_count > 1;

// Visited within last hour
const oneHour = 60 * 60 * 1000;
return visit_data.time_since_last_visit < oneHour;

// Visited long ago, re-engagement
const thirtyDays = 30 * 24 * 60 * 60 * 1000;
return visit_data.time_since_first_visit > thirtyDays && visit_data.visit_count > 1;

// Block suspicious behavior (bot detection)
return visit_data.rapid_visits_detected !== true && 
       visit_data.page_visit_count_30min < 20;

// High-intent visitors
return visit_data.unique_pages_visited >= 3 && visit_data.visit_count >= 2;

// Check if user switched devices (possible sharing)
return visit_data.has_multiple_user_agents === false;

​

Debugging Script Rules

​

Using the Debug Window

1. Open the Debugger - Click the “Debugger” button in the Page Builder or Page Events interface
2. This will open your page with the Debug Window automatically activated
3. Navigate to “Page Events” tab in the Debug Window to see Script Rule execution details
4. Reload the page if needed to trigger the Script Rule

• Result: TRUE or FALSE - which path was taken
• Execution Time: How long the script took to run (in milliseconds)
• Next Path: Which branch the flow followed
• Console Messages: All your console.log(), console.warn(), and console.error() output
• Errors: Full error messages if the script failed
• Used IP Whois: Whether geolocation data was loaded
• Used Click Data: Whether click data was accessed
• Has Customer Data: Whether customer information was available
• Script Preview: First few lines of your script code
• Full Context: Complete evaluation data with all variable values

​

Console Logging

console.log('Current country:', ip_whois.country);
console.log('Visit count:', visit_data.visit_count);
console.log('Is customer:', is_customer);

return ip_whois.country === 'US';

// Log all available data to understand what you have
console.log('Query params:', query);
console.log('Is mobile:', is_mobile);
console.log('Is customer:', is_customer);
console.log('Visit count:', visit_data?.visit_count);
console.log('Country:', ip_whois?.country);

// Log your condition results
const isEligible = ip_whois.country === 'US' && visit_data.visit_count > 1;
console.log('Is eligible:', isEligible);

return isEligible;

​

Example Use Cases

​

Example 1: Geographic Targeting

// US and Canada only, block VPNs
return (ip_whois.country === 'US' || ip_whois.country === 'CA') &&
       ip_whois.proxy !== true &&
       ip_whois.hosting !== true;

​

Example 2: Customer Segmentation

// Returning customers who haven't visited in 30+ days
const thirtyDays = 30 * 24 * 60 * 60 * 1000;
return is_customer === true && 
       visit_data.time_since_last_visit > thirtyDays;

​

Example 3: Anti-Fraud Protection

// Block suspicious patterns when click data is available
return click_data.ip_address_matches === true &&
       click_data.seconds_ago < 3600 &&
       visit_data.rapid_visits_detected !== true &&
       ip_whois.is_bot !== true &&
       ip_whois.proxy !== true;

​

Example 4: Device & Platform Targeting

// iOS users only, version 14 or higher
return device.os === 'iOS' && 
       parseInt(device.os_version) >= 14 &&
       device.brand === 'Apple';

​

Example 5: Behavior-Based Routing

// High-engagement visitors: viewed 3+ pages, visited 2+ times
return visit_data.unique_pages_visited >= 3 &&
       visit_data.visit_count >= 2 &&
       tags.includes('viewed_vsl');

​

Example 6: Multi-Condition Affiliate Routing

// Specific affiliate from US, mobile device, first-time visitor
return session.aff_id === 'AFF123' &&
       ip_whois.country === 'US' &&
       is_mobile === true &&
       visit_data.visit_count === 1;

​

Example 7: Time-Based Offers

// Weekend special offer (UTC)
const now = new Date(utc_timestamp);
const dayOfWeek = now.getUTCDay(); // 0 = Sunday, 6 = Saturday
return dayOfWeek === 0 || dayOfWeek === 6;

​

Example 8: Tag-Based Progressive Disclosure

// Visitor watched VSL and clicked CTA but hasn't purchased
return tags.includes('watched_vsl') &&
       tags.includes('clicked_cta') &&
       is_customer === false;

​

Best Practices

​

Performance Optimization

1. Avoid Heavy Operations When Possible
   • Only reference ip_whois if you need geolocation
   • Only reference click_data if you need click attribution (requires click ID)
   • Only reference visit_data if you need behavior metrics
2. Simple Checks First
   Copy

   // Good: Check simple conditions before heavy operations
   if (!is_customer) return false; // Fast check first
   
   // Then check heavy data
   return ip_whois.country === 'US';
   
3. Use Tags for Behavior Tracking
   Copy

   // Show different upsell based on whether they watched the VSL
   // Tag 'watched_vsl' is set on VSL page when video completes
   return tags.includes('watched_vsl');
   

​

Logic Clarity

1. Comment Your Code
   Copy

   // Route high-value traffic: US/CA, mobile, new visitors
   return (ip_whois.country === 'US' || ip_whois.country === 'CA') &&
          is_mobile === true &&
          visit_data.visit_count === 1;
   
2. Break Complex Logic into Steps
   Copy

   // Check geographic eligibility
   const isEligibleCountry = ip_whois.country === 'US';
   
   // Check device requirements
   const isCorrectDevice = is_mobile && !is_tablet;
   
   // Check behavior requirements
   const isNewVisitor = visit_data.visit_count === 1;
   
   return isEligibleCountry && isCorrectDevice && isNewVisitor;
   
3. Use Meaningful Variable Names
   Copy

   const isVipCustomer = is_customer && customer.order_ids.length > 3;
   const isRecentVisit = visit_data.time_since_last_visit < (7 * 24 * 60 * 60 * 1000);
   
   return isVipCustomer && isRecentVisit;
   

​

Error Handling

1. Check for Null/Undefined
   Copy

   // Good: Check if data exists before using it
   return ip_whois && ip_whois.country === 'US';
   
   // Good: Array check
   return customer.order_ids && customer.order_ids.length > 0;
   
2. Provide Fallback Values
   Copy

   // Fallback to false if data unavailable
   const country = ip_whois?.country || 'unknown';
   return country === 'US';
   

​

Testing

1. Test Both Paths
   • Verify the true path works as expected
   • Verify the false path works as expected
   • Test edge cases (missing data, null values, etc.)
2. Use Debug Window
   • Click “Debugger” in Page Builder or Page Events to open Debug Window
   • View console logs and script execution details in the “Page Events” tab
3. Test with Different IPs/Devices
   • Use VPN to test different countries
   • Use browser dev tools to simulate mobile devices
   • Test with different referrers and query parameters

​

Troubleshooting

​

Script Returns Unexpected Results

1. Use the Debug Window - Click “Debugger” in the Page Builder or Page Events to see the actual result and all data
2. Check your return statement - must return boolean
3. Use console.log() to debug variable values
4. Verify data is available (not null/undefined)
5. Check for typos in property names

// Debug example - add these logs and check Debug Window
console.log('Country:', ip_whois?.country);
console.log('Visit count:', visit_data?.visit_count);
console.log('Is customer:', is_customer);

return ip_whois.country === 'US';

• The actual Result (TRUE or FALSE)
• All your console logs
• What data was actually available
• The exact path taken (Next Path)

​

Script Execution Errors

1. Check Debug Window - Click “Debugger” in the Page Builder to see the exact error message
2. Check for syntax errors in your code
3. Look at the error details in Debug Window → Page Events → script_rule event
4. Ensure you’re not using unsupported JavaScript features
5. Verify all referenced variables exist

1. Click “Debugger” in the Page Builder or Page Events interface
2. The Debug Window will open automatically
3. Go to Page Events tab
4. Find the script_rule event with red/error status
5. Look at the Error field for the exact error message
6. Check Full Context to see what data was available

// Bad: Using unsupported features
const result = array.flatMap(x => x);  // flatMap not supported

// Good: Use supported methods
const result = array.map(x => x);

// Bad: Undefined variable
return customVariable === true;  // customVariable doesn't exist

// Good: Use available variables
return is_customer === true;

​

Slow Performance

1. Remove ip_whois reference if not needed
2. Remove click_data reference if not needed (requires click ID to be present)
3. Remove visit_data reference if not needed
4. Simplify logic to avoid heavy operations

// Slow: Uses all heavy operations
return ip_whois.country === 'US' &&
       click_data.seconds_ago < 3600 &&
       visit_data.visit_count > 1;

// Fast: Use simple checks only
return query.country === 'US' && is_customer === true;

​

Data Not Available

1. ip_whois: Make sure you reference it in your script (triggers lookup)
2. click_data: Only available when there’s a click ID present
3. visit_data: Data may not be available for first-time, brand-new visitors

// Safe check with fallback
if (!ip_whois || !ip_whois.country) {
    return false; // Default behavior if geolocation fails
}

return ip_whois.country === 'US';

​

JavaScript Limitations

​

Supported Features

• Basic JavaScript syntax (ES5 + some ES6)
• Variables (let, const, var)
• Functions and arrow functions
• Arrays and objects
• Loops (for, while, forEach)
• Conditionals (if, switch, ternary)
• Comparison and logical operators
• Math, Date, JSON objects
• String and Array methods (most common ones)
• console.log() for debugging

​

NOT Supported

• Async/await operations
• Promises
• Fetch API or HTTP requests
• Browser APIs (window, document, localStorage, etc.)
• ES6+ features like flatMap, Object.fromEntries
• Regular expressions with some advanced features
• Modules and imports

​

Polyfills Included

• Array.prototype.includes()
• String.prototype.includes()

​

Related Documentation

• Debug Window - Learn how to debug Script Rules with the Debug Window
• Page Events - Overview of the Page Events system
• Query Parameter Conditions - Simpler alternative for URL parameter checks
• Content Visibility Control - Using whitelisting with containers
• Dynamic Content - Personalizing content based on conditions
• Exit Popups - Behavior-based exit intent detection