GuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

Instruct the Optimizely snippet to hold and enqueue events.

Description

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

The snippet must be configured to the 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.

Parameters

Type

Description

holdEvents
required

object

An object with the type field set to holdEvents.

The other fields are the function arguments.

holdEvents.type
required

string

The argument indicating that you are using the holdEvents function.