Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Instruct the Optimizely Performance Edge snippet to hold and enqueue events.

Description

Use in conjunction with sendEvents for granular control over the timing of when the Optimizely Performance Edge snippet sends events to the logging endpoint.

The snippet must be configured to use the /events logging endpoint in order to use this method. Learn more about how to enable this feature for your snippet.

🚧

Use caution

Failure to call sendEvents after using this method will effectively disable all tracking until the snippet is reinitialized.

window.optimizelyEdge.push(holdEvents);
window.optimizelyEdge.push({
  "type": "holdEvents"
});

Parameters

This table provides general information about required and optional parameters.

ParametersTypeDescription
holdEvents
required
objectAn object with the type field set to holdEvents.

The other fields are the function arguments.
holdEvents.type
required
stringThe argument indicating that you are using the holdEvents function.