Back

This article describes how to set up the Optimizely Events connector in your Universal Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Send Event

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Send Event

Parameters

Parameter Description
Account ID
  • The Optimizely account to which these events should be attributed.
Enrich Decisions
Campaign ID
  • The ID of the campaign containing this experiment.
Experiment ID
  • The ID of the experiment the visitor was exposed to.
  • For Personalization Campaigns, clients should explicitly send "null" as the Experiment ID for visitors not bucketed into any Experiment, for the purpose of accurately computing Campaign reach.
Variation ID
  • The ID of the variation the visitor was exposed to.
  • For Personalization Campaigns, clients should explicitly send "null" as the Variation ID for visitors not bucketed into any Experiment, for the purpose of accurately computing Campaign reach.
Is Campaign Holdback
  • True or false.
  • If true, the chosen experience was held back at the campaign level.
  • Required for Personalization, omit otherwise.
Timestamp
  • Timestamp at which the event was generated, formatted in milliseconds since Unix epoch.
UUID
  • A unique identifier for this Event.
  • This may be generated by the client with a typical UUID-generating method.
  • Used by Optimizely's backend to de-duplicate requests that are accidentally or erroneously replayed.
  • Optimizely detects events that have the same entity_id, uuid and timestamp and saves only one of them. Make sure each event is using a unique uuid or timestamp before sending.
Entity ID
  • The ID of the entity corresponding to this Attribute.
  • This is only required for custom attributes (type="custom"), and invalid for other Attribute types.
Event Name
  • The event key (aka API name) for this event.
Event Data
  • Additional event data in key-value pairs.
Tags
  • Key-value attributes related to tags. If used, "type" and "value" must be included as two of the keys.
Event Type
  • The type of event.
  • For example, to indicate a "decision_point" type should be "campaign_activated."
Event Value
  • A scalar value associated with an event.
  • This should be some non-revenue number.
Visitor ID
  • A unique identifier for the visitor.
Attributes
  • Attributes associated with this visitor at the time of this request.
Session ID
  • A unique identifier that identifies the session context, if any, for these events.
  • If omitted, the Optimizely backend will calculate session-based results by inferring sessions by opening a session when an event is first received from a given visitor_id, and closing the session after 30 minutes with no events received for that visitor, with a maximum session size of 24 hours.
Anonymize IP
  • True or false.
  • Optimizely typically stores the client IP address for each request.
  • If this flag is true, the last octet of the IP will be truncated before it is stored.
  • .
  • If false, the entire IP address will be stored.
  • This is most relevant for consumers of this API that are implemented in a web browser or mobile client context who are subject to policies or regulation restricting the storage of end-user identifying information.
  • Note that this flag is independent of the IP anonymization setting in the Account and Project settings, which only controls how Optimizely clients set this flag.
  • Also note that if this flag is set, care must be taken when using the IP filtering features, as fully-qualified explicit IP addresses will not function as filters (anonymization occurs before events are filtered by IP).
Client Name
  • A unique identifier for the system that generated this event.
  • By convention, this should be something like "organization_name/system_name."
  • We recommend that you include the Client Name and Client Version fields for debugging purposes.
  • For a complete description of the Event API, consult the Event API reference.
Client Version
  • A version identifier for the system that generated this event.
Project ID
  • The Project ID needs only to be passed if you are using the Recommendations product.