Dev guideAPI Reference
Dev guideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

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

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

Prerequisites

You must configure Real-Time Segments for Feature Experimentation before sending events to Optimizely Data Platform (ODP) from Feature Experimentation.

Minimum SDK version

2.0.0

Description

The Optimizely Client extension method, SendOdpEvent, lets you send data to the ODP server. This data can then be used to analyze user behavior and optimize experiences across different channels and touchpoints.

The SendOdpEvent method can be used 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. When using this method, 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 endpointor ODP UI to manage customer profiles.

Sending events to Optimizely Data Platform

πŸ“˜

Notes

  • The Go SDK discards the event immediately if there are any errors (sdkNotReady, odpNotIntegrated, or odpNotEnabled).
  • All events (implicit or explicit) are discarded, if requested before the datafile is ready and a warning log is sent.
    • The datafile is expected to be fully ready in the Go SDK before you create user contexts and accept decision requests.

Parameters

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

ParameterTypeDescription
eventTypeStringThe type of event to be sent. Is "fullstack" for all Go SDK-generated events if not specified.
action
required
StringSpecifies the subcategory of the event type, which is used to track the app and user lifecycle.
identifiersmap[string]stringA key-value map of user identifiers. At least one key-value pair is required.
datamap[string]interface{}The event data in a key-value map. The value can be any type (string, number, or boolean.) Null values are allowed but are interpreted as empty strings.

The Go SDK adds default event data to the given data dictionary. You can overwrite the default data values by sending the same key when creating your HashMap.

  • "idempotence_id":<UUID created by the Go SDK>

  • "data_source_type":"sdk"

  • "data_source":"go-sdk"

  • "data_source_version":<Go SDK version implemented>

Returns

This method sends event data to the Optimizely Data Platform (ODP) server. It returns an error when any issue occurs, otherwise returns nil.

Example

identifiers := map[string]string{"fs_user_id": "user123", "email": "[email protected]"}
data := map[string]interface{}{"item": "shirt", "price": 50.00}

err := optimizelyClient.SendOdpEvent("fullstack", "purchased", identifiers, data)

The following diagram shows the network calls between your application, the Go SDK, and the ODP server when calling the SendOdpEvent method.

Go SDK network diagram to ODP
  1. Your application calls the SendOdpEvent method.
  2. The Go SDK makes a POST request to ODP.
  3. ODP responds with acknowledgment or relevant error.

Source files

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