Send Optimizely Data Platform data using Real-Time Segments for Feature Experimentation for the Swift SDK

Describes the sendOdpEvent method, which sends Optimizely Feature Experimentation event data to the Optimizely Data Platform (ODP) server.

Suggest Edits

Prerequisites

You must enable the Real-Time Segments for Feature Experimentation integration before sending events to ODP from Feature Experimentation.

Minimum SDK version

4.0.0

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:

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.

Sending events to Optimizely Data Platform

The Swift 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
type	String?	The type of event to be sent. It is "fullstack" for all Swift SDK-generated events if not specified.
action required	String	Specifies the subcategory of the event type used to track the app and user lifecycle.
identifiers	[String: String]	A key-value map of user identifiers. The Swift SDK automatically adds the `vuid` key-value pair to this optional user-provided identifiers.
data	[String: Any?]	The event data in a key-value map. The value can be any type (string, number, or boolean.) You can use null values, but they become empty strings. The Swift SDK adds default event data to the given data dictionary. Sending the same key when creating your Dictionary overwrites the default data values. "idempotence_id":<UUID created by the Swift SDK> "data_source_type":"sdk" "data_source":"swift-sdk" "data_source_version":<Swift SDK version implemented>

Returns

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

Example

let identifiers: [String: String] = [
        "fs_user_id": "user123",
        "email": "[email protected]"
    ]
    let data: [String: Any] = [
        "item": "shirt",
        "price": 50.00
    ]
    try? optimizelyClient.sendOdpEvent(type: "fullstack", action: "purchased", identifiers: identifiers, data: data)

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

Your application calls the sendODPEvent method.
The Swift 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 Swift are available on GitHub.

Updated 8 months ago