JavaScript API

The Command Queue

The tracking script exposes a command queue via window._conv_q. You can push commands to this queue before or after the script loads — commands pushed before the script loads are processed once it initialises.

// Always initialise safely
window._conv_q = window._conv_q || [];

// Push a command
window._conv_q.push({
  what: 'methodName',
  params: { key: 'value' }
});

Important: Always use window._conv_q = window._conv_q || [] — never assign an empty array directly, as this overwrites any commands already in the queue.

Command Format

Commands can use the modern object format or the legacy array format:

// Modern (recommended)
window._conv_q.push({ what: 'identify', params: { visitorId: 'abc123' } });

// Legacy
window._conv_q.push(['identify', { visitorId: 'abc123' }]);

Available Commands

Visitor Identification

Command	Description	Parameters
`identify`	Set a custom visitor ID (BYOID)	`{ visitorId: string }`

The visitorId must use only 0-9, a-z, A-Z, ., - and _. As a regular expression, the rule is ^[0-9a-zA-Z._-]+$. Keep the ID to 64 characters or fewer. One longer ID can stop reports from using visitor-level revenue statistics for its whole variation. An ID over 256 characters may not be tracked at all.

The tracking script accepts any value, but the tracking server drops every event for an ID that breaks the rule. It still answers 200 OK, and experiences still render, so nothing reaches your reports or Live Logs without any visible error. An Auth0 user ID such as auth0|64f1c2… and an email address both break the rule. URL-encoding does not help, because % is not allowed either. Pass its SHA-256 hex digest instead, which is exactly 64 characters. Do not use a longer digest such as SHA-512.

Consent Management

Command	Description	Parameters
`consentRequired`	Block tracking until consent is given	`{ runExperiences?: boolean }` (default: `true`)
`consentGiven`	Signal that consent has been given — flushes queued events and re-runs the script	—

When runExperiences is false, both experiments and data collection are blocked until consent. When true (default), experiments display immediately but data collection waits.

Experience Control

Command	Description	Parameters
`run`	Re-run the full evaluation cycle	—
`assignVariation`	Programmatically decide a variation	`{ experienceId, variationId }`
`triggerExperienceVariation`	Force a specific variation (testing)	`{ experienceId, variationId }`
`executeExperience`	Manually run a specific experience	`{ experienceId }`
`disableExperience`	Disable a specific experience	`{ experienceId }`
`enableExperience`	Re-enable a disabled experience	`{ experienceId }`
`disableVariation`	Disable a specific variation	`{ experienceId, variationId }`
`enableVariation`	Re-enable a disabled variation	`{ experienceId, variationId }`
`doNotRunExperiences`	Disable all experience processing	—
`checkExperiences`	Re-evaluate deferred experiences	—

Goal Tracking

Command	Description	Parameters
`triggerConversion`	Manually trigger a goal	`{ goalId, experienceId? }`
`triggerConversions`	Trigger multiple goals	Same as `triggerConversion`
`sendRevenue`	Track a revenue transaction	`{ goalId?, transactionId, amount, productsCount? }`
`pushRevenue`	Alternative revenue tracking	`{ amount, productsCount?, goalId?, transactionId? }`
`recheckGoals`	Re-evaluate all goals	—

Segments

Command	Description	Parameters
`placeVisitorIntoSegment`	Manually place visitor into a segment	`{ segmentId }`
`checkSegments`	Re-evaluate segments that were waiting for data	—

Location Triggers

Command	Description	Parameters
`triggerLocation`	Manually activate a location trigger	`{ locationId }`

Configuration

Command	Description	Parameters
`setParameters`	Set tracking script parameters	`{ delayContinuousActivation?, throttleChanges?, interceptEventsEarly? }`
`setIntegrationVariable`	Set a custom variable for targeting	`{ key, value }`
`showBody`	Force-remove the anti-flicker overlay	—

Navigation

Command	Description	Parameters
`refresh`	Reload the current page (for split URL original)	—
`redirect`	Navigate to a URL (for split URL variation)	`{ url: string }`

Events

Command	Description	Parameters
`addListener`	Listen for lifecycle events	`{ event, handler }`
`ready`	Callback when the script has initialised	`function`

Lifecycle Events

You can listen for events fired during the tracking script's lifecycle:

window._conv_q = window._conv_q || [];
window._conv_q.push({
  what: 'addListener',
  params: {
    event: 'experience.activated',
    handler: function(data) {
      console.log('Experience activated:', data.experienceId, data.variationId);
    }
  }
});

Available Events

Event	Description	Data
`snippet.initialized`	Script started	—
`snippet.segments_evaluated`	Segments processed	`{ visitorId }`
`snippet.experiences_evaluated`	Experiences processed	—
`snippet.goals_evaluated`	Goals processed	—
`experience.activated`	Experience shown to visitor	`{ experienceId, variationId }`
`experience.variation_decided`	Variation selected	`{ experienceId, variationId }`
`goal.triggered`	Goal conversion recorded	`{ goalId }`
`location.activated`	Location trigger matched	`{ locationId }`
`location.deactivated`	Location trigger unmatched	`{ locationId }`
`url.changed`	SPA navigation detected	`{ from, to }`
`render.complete`	Page shown (anti-flicker removed)	—

Timing: Listeners must be registered before the script processes them — either before the script loads, or from Global JavaScript. Listeners added after the script initialises will miss events that already fired.