The Full Stack Developer Guide Developer Hub

Welcome to the Full Stack Developer Guide developer hub. You'll find comprehensive guides and documentation to help you start working with the Full Stack Developer Guide as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Track events

Introduction

Experiments let you track how users reacted to the different variations. So, you'll need to tell Optimizely which events to track in order to gauge the relative success of your feature test. After Optimizely aggregates enough events to produce meaningful metrics, you'll be able to judge your experiment variations on the Results page.

As part of your experimental design process, you'll choose on how to aggregate your tracked events into metrics. Events that power metrics are referred to as conversion events. Conversion events can be big or small. You can implement conversion events to capture clicks, pageviews, form submissions, purchases, scroll depth, etc. In general, you want to track events that are closely associated in terms of user experience to the experimental changes you're making.

Setup overview

At a high level, you'll take these steps:

  1. In the Optimizely app, create an event key string and add it to your experiment. See Create events.
  2. Copy the sample integration code for the Track method that Optimizely generates.
  3. Use the Track method to label the event code you want to track. In order for your conversion event to populate metrics on the Results page, you should be tracking event code that a user is exposed to if:

    • you previously passed their user ID to Is Feature Enabled or Activate and
    • Based on the output of the previous call, the user is exposed to the experiment.
      Note: We recommend getting in the habit of tracking interesting events even if they're not behind feature flags, so you can more easily create future experiments.

    Now, every time a user triggers the event, Track passes to Optimizely:

    • event key: string that matches the event key you created in the Optimizely app.
    • user ID: The user ID must match the ID you passed to the Feature Enabled method.
    • (Recommended ) userAttributes If you set an audience for your experiment, then this is required so that Optimizely can determine if the user who triggered the event is in the experiment audience. Optimizely also uses this information to give you a visual segmentation of audiences on the Results page.
  4. (Recommended) Filter out third-party bots so they don't skew your experimental results. For more information see Filter out bots.

You can track events server-side using one of the Full Stack SDKs, or client-side using the JavaScript SDK. You can also track events using our Events API where you do not have an Optimizely SDK implemented. For more information, see Track across platforms.

Troubleshooting empty results

The Results page only shows events that are tracked after Is Feature Enabled has been called for the user who triggered the event. If you do not see results on the Results page, make sure that you are evaluating the feature flag before tracking conversion events.

Example code

The example below shows Track called with all parameters, including optional user attributes.

// Track a conversion event for the provided user with attributes
optimizelyClient.track(eventKey, userId, attributes);

// Track a conversion event for the provided user with attributes
OptimizelyClient.Track(eventKey, userId, attributes);

// Track a conversion event for the provided user with attributes
optimizelyClient.track(eventKey, userId, attributes);

// Track a conversion event for the provided user with attributes
optimizelyClient.track(eventKey, userId, attributes);

// Track a conversion event for the provided user with attributes
optimizelyClient.track("my_conversion", userId, {
  plan_type: "silver"
});

// Track a conversion event for the provided user with attributes
[optimizely track:@"my_conversion"
           userId:@"user123"
       attributes:attributes];

// Track a conversion event for the provided user with attributes
$optimizelyClient->track($eventKey, $userId, $attributes);

# Track a conversion event for the provided user with attributes
optimizely_client.track(event_key, user_id, attributes)

# Track a conversion event for the provided user with attributes
optimizely_client.track(event_key, user_id, attributes)

// Track a conversion event for the provided user with attributes
optimizely?.track("my_conversion", userId:"user123", attributes:attributes)

For more information about when and how to track events, see the other topics in this section.

Track events across platforms

In circumstances where you can't install our SDK (for example, for offline event tracking and other advanced use cases), you can instead use the Event API.

In circumstances where you can install our SDK, you can rest assured that all of our SDK languages have the same audience evaluation and targeting behavior, so you'll see the same output from experiment activation and tracking as long as you are using the same datafile and user IDs. You can use any of our SDKs to track events, so you can run experiments that span multiple applications, services, or devices.

For example, if you're running experiments on your server, you can activate experiments with our Python, Java, Ruby, C#, Node, or PHP SDKs, but track user actions client-side using our JavaScript, Objective-C or Android SDKs.

If you plan to use multiple SDKs for the same project, make sure that all SDKs share the same datafile and user IDs.

For more information, see Multiple languages.

Track numeric metrics

It’s possible to track nonbinary metrics on the Results page, such as revenue or other numeric values. For information on using reserved event tags to track nonbinary metrics, see Tag events.

Next Steps

After you've created an event:

Important

The Easy Event Tracking functionality included in the Full Stack v3.0 release changes the results of the Optimizely Data Export.

When implementing Full Stack v3.0, you must also upgrade to the Results Exports functionality to obtain reliable event attribution data. For more information, see the Important note in the changelog.

Updated 4 months ago


Track events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.