Send Optimizely Data Platform data with Real-Time Audiences for Feature Experimentation for the JavaScript SDK v6+

6 min

Prerequisites

You must configure Real-Time Audiences for Feature Experimentation before sending events to ODP from Feature Experimentation.

Minimum SDK version

v6.0.0+

For versions 5.3.5 and below, see JavaScript (Browser) SDK or JavaScript (Node) SDK. See the SDK compatibility matrix documentation for a list of current SDK releases and the features they support.

Description

The Optimizely Client extension method sendOdpEvent lets you send data to the ODP server. You can then use this data to analyze user behavior and optimize experiences across different channels and touchpoints.

Use the sendOdpEvent method to complete the following:

Merge or stitch users together and determine which event is associated with which customer.

Send various types of events and actions, such as pageviews, clicks, form submissions, and others. You can include additional data to provide more context and information about the event being tracked.

For example, by connecting an email address identifier with a fs_user_id identifier, you can use the sendOdpEvent method to send events that are associated with both identifiers. This enables you to track and analyze the behavior of a specific user across different touchpoints and devices.

You cannot create or update user profile data like name or address with sendOdpEvent. Instead, you can use the ODP Create and update customers API endpoint or ODP UI to manage customer profiles.

Send events to Optimizely Data Platform

The JavaScript SDK discards the event immediately if there are any errors (sdkNotReady, odpNotIntegrated, or odpNotEnabled).

Parameters

This table lists the required and optional parameters for the sendOdpEvent method.

Parameter	Type	Description
`action` _required_	String	Specifies the subcategory of the event type, which is used to track the app and user lifecycle.
`type`	String	The type of event to be sent. Defaults to "fullstack" for all JavaScript SDK-generated events if not specified.
`identifiers`	Map\	A key-value map of user identifiers. The JavaScript SDK adds the `vuid` key-value pair to this optional user-provided identifiers.
`data`	Map\	The event data in a key-value map. The value can be any type (string, number, or boolean.) Null values are allowed but will be interpreted as empty strings. The JavaScript SDK adds default event data to the given data dictionary. The default data values can be overwritten by sending the same key when creating your dictionary. "idempotence\_id":\ "data\_source\_type":"sdk" "data\_source":"javascript-sdk" "data\_source\_version":\

Returns

This method sends event data to Optimizely Data Platform (ODP). It does not provide return values.

Example

Method signature for sendOdpEvent

sendOdpEvent(action: string, type?: string, identifiers?: Map<string, string>, data?: Map<string, unknown>): void;

const identifiers = new Map([["fs_user_id", "user123"], ["email", "[email protected]"]]);
const data = new Map([["count", 1]]);

try {
  optimizelyInstance.sendOdpEvent("purchased","fullstack", identifiers, data);
} catch (error) {
  // handle error here
}

The following diagram shows the network calls between your application, the JavaScript SDK, and the ODP server when calling the sendOdpEvent method:

Your application calls the sendOdpEvent method.

The JavaScript SDK makes a POST request to ODP.

ODP responds with acknowledgment or relevant error.

Source files

The language and platform source files containing the implementation for JavaScript are available on GitHub.