Integrate Segment (Legacy)

The Optimizely Data Platform (ODP)-Segment integration lets you import events and other customer data collected in Segment to ODP. 

Configure Segment

Enable the ODP-Segment integration:

1. Go to Account Settings >Integrations > Segment.
2. Toggle on Enable Segment.
3. Select Sign In and follow the prompts in Segment.

Data details

ODP uses the following event types from Segment.io along with the standard fields associated with each event type to automatically create the corresponding ODP events.

• Identify
• Track
• Page / Screen
• Email

Below is a table outlining the common fields from Segment.io and the corresponding field in the ODP event.

Identify

Identify tracks anonymous users with the Segment anonymousId. As soon as users become identified with an email address or another customer ID, Segment merges this data set with anonymous activity automatically. ODP uses the same approach, and the Segment integration brings these two data sets together.

Segment also has the following standard fields for an identify event, and ODP maps them to a corresponding field.

ODP applies any other field found in Segment's identify event as a custom field.

Track

ODP can process any Segment track events and properties. Additionally, ODP has implemented the following special semantic events whose structure you can view on Segment's site:

• Email
• ECommerce V1
• ECommerce V2

These semantic events correspond to specific ODP event_type and action pairs found on standard ODP events. Below is a table detailing each Segment semantic event to the ODP event_type and action.

Track events not listed

If the Segment event does not fit into one of the provided semantics, ODP will map the event as:

• Event Type: "track"
• Action: "Your Event"

Segment events that correspond to the ODP event type order have special properties that correspond to ODP Fields.

The order event properties may also list fields for each product. Below is a list of Segment product properties for an order and the corresponding ODP field.

Order Item Subtotal

Segment does not provide any field for subtotal per item in a given order. ODP calculates this field as order_item.price * order_item.quantity.

Page/Screen

Segment page events show up in ODP as pageview event types. Below is a list of the standard segment fields for a page event and the corresponding ODP fields.

Email

The standard fields for all Segment events are mapped to ODP fields for email events.

If you are already integrating an email service provider (ESP) directly, you do not need to send semantic events for email as those are captured directly from the ESP.

Custom Field Support

ODP supports custom fields in Segment events. You must place custom fields in either the traits or properties objects for a given Segment event.

Example: Segment.io event (Note the "myCustomField" key in the properties object)

{
  "anonymousId": "23adfd82-aa0f-45a7-a756-24f2a7a4c895",
  "context": {
    "library": {
      "name": "analytics.js",
      "version": "2.11.1"
    },
    "page": {
      "path": "/academy/",
      "referrer": "",
      "search": "",
      "title": "Analytics Academy",
      "url": "https://segment.com/academy/"
    },
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36",
    "ip": "108.0.78.21"
  },
  "event": "Course Clicked",
  "integrations": {},
  "messageId": "ajs-f8ca1e4de5024d9430b3928bd8ac6b96",
  "properties": {
    "title": "Intro to Analytics",
    "myCustomField": "my_custom_field_value"
  },
  "receivedAt": "2015-12-12T19:11:01.266Z",
  "sentAt": "2015-12-12T19:11:01.169Z",
  "timestamp": "2015-12-12T19:11:01.249Z",
  "type": "track",
  "userId": "AiUGstSDIg",
  "originalTimestamp": "2015-12-12T19:11:01.152Z"
}