Zaius Integration

Zaius is a behavioral marketing engine that allows marketers analyze, segment, and engage their customers across web, mobile, email and offline channels and devices.

When integrated with Segment, you'll be able to:

  • View your Customer Journey
  • Use our cross-channel analytics
  • Segment your customers
  • Execute coordinated cross-channel personalized campaigns across email, push, facebook and google.

Getting Started

It's easy to get started!

  • If you don't have a Zaius account yet, sign up for a free account at http://www.zaius.com
  • Sign in to your account and navigate to Cog Icon > Data Management > Integrations
  • Click the Segment tile and select "Enable with Segment"
  • Follow the prompts in the segment app to send us data!

Content Blocker Notice

If you have any ad blocking or content blocking software installed on your browser, the "Enable with Segment" button may not appear. If you're not seeing the button, please turn off your blocking technology and refresh the page.

Data Details

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

  • Identify
  • Track
  • Page / Screen

For each event type listed above there are common fields Segment.io attaches to each event. Below is a table outlining the common fields from Segment.io and the corresponding field in the Zaius event.

Segment.io Field

Zaius Field

anonymousId

vuid

userId

customer_id

timestamp

ts

context.locale

language

context.page.path

page

context.referrer.url

referrer

context.page.referrer

referrer

context.page.search

search_term

context.page.title

title

context.page.url

hostname

context.ip

ip

context.user_agent

ua

context.timezone

timezone

context.campaign.name

campaign

context.campaign.source

source

context.campaign.medium

medium

context.campaign.term

keywords

context.campaign.content

content

Custom Fields Support

Zaius also supports custom fields in Segment.io events. Custom fields are to be placed in either the traits or properties objects for a given Segment.io 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"
}

Identify

Segment.io Identify
Zaius Customer

Identify is key to using Zaius. When users are not logged in we will track anonymous activity based on the Segment anonymousId. As soon as users become identified with an email address or another customer ID, we will merge this data set with anonymous activity automatically. In addition to the common fields mentioned previously, below are the Segment.io standard fields for an identify event and how they are mapped to Zaius fields.

Segment.io Field

Zaius Field

traits.firstName

first_name

traits.lastName

last_name

traits.name

name

traits.email

email

traits.address.country

country

traits.address.state

state

traits.address.city

city

traits.address.postalCode

zip

traits.address.street

street1

traits.avatar

image_url

traits.phone

phone

traits.gender

gender

Custom Fields Reminder

Any field found in the traits object of the Segment.io identify event that is not listed above will be applied to the corresponding Zaius event as a custom field.

Track

Segment.io Track
Zaius Event

Zaius will be able to process any of your track events and properties sent through. Additionally Zaius has implemented the following special semantic events whose structure can be viewed on Segment's site:

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

Segment.io Event

Zaius Event Type

Zaius Action

Products Searched

navigation

search

Product List Viewed

navigation

list

Product List Filtered

navigation

filter

Promotion Viewed

promotion

view

Promotion Clicked

promotion

click

Product Clicked

product

click

Product Viewed

product

detail

Product Added / Removed

product

add_to_cart / remove_from_cart

Cart Viewed

cart

view

Checkout Started

checkout

start

Checkout Step Viewed

checkout

step_view

Checkout Step Completed

checkout

step_complete

Payment Info Entered

checkout

payment_info_enter

Order Completed

order

purchase

Order Updated

order

purchase

Order Refunded

order

refund

Order Cancelled

order

cancel

Coupon Entered

checkout

coupon_enter

Coupon Applied

checkout

coupon_apply

Coupon Denied

checkout

coupon_deny

Coupon Removed

checkout

coupon_remove

Product Added to Wishlist / Product Removed from Wishlist

product

add_to_wishlist / remove_from_wishlist

Product Shared

product

share

Cart Shared

cart

share

Product Reviewed

product

review

Email Bounced

email

soft_bounce

Email Opened

email

open

Email Link Clicked

email

click

Email Marked as Spam

email

spamreport

Unsubscribed

email

unsubscribe

Viewed Product Category

navigation

category

Viewed Product

product

detail

Added / Removed Product

product

add_to_cart / remove_from_cart

Completed Order

order

purchase

Track events not listed

The above events are only part of Segment's list of special semantic events, we recommend using those as much as possible. However, if your Segment event does not fit into one of the provided semantics, Zaius will map your event as:

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

The Segment.io events that correspond to the Zaius event type order have special properties that correspond to Zaius Fields.

Segment.io Field

Zaius Field

properties.order_id

order.order_id

properties.total

order.order_total

properties.revenue

order.order_subtotal

properties.discount

order.order_discount

properties.tax

order.order_tax

properties.shipping

order.order_shipping

properties.coupon

order.coupon_code

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

Segment.io Field

Zaius Field

properties.products.$.id

order.items.$.product_id

properties.products.$.product_id

order.items.$.product_id

properties.products.$.sku

order.items.$.sku

properties.products.$.price

order.items.$.item_price

properties.products.$.quantity

order.items.$.item_quantity

N/A

order.items.$.item_subtotal*

Order Item Subtotal

Segment.io does not provide any field for subtotal per item in a given order. Zaius will calculate this field as order_item.price * order_item.quantity.

A Complete Segment.io Order event and corresponding Zaius Order event

Below is an example Segment.io Order Completed Event, on the next tab of the code sample you will find exactly how this event was transformed into a Zaius order event.

{
  "anonymous_id": "507f191e810c19729de860ea",
  "context": {
    "active": true,
    "app": {
      "name": "InitechGlobal",
      "version": "545",
      "build": "3.0.1.545"
    },
    "campaign": {
      "name": "TPS Innovation Newsletter",
      "source": "Newsletter",
      "medium": "email",
      "term": "tps reports",
      "content": "image link"
    },
    "device": {
      "id": "B5372DB0-C21E-11E4-8DFC-AA07A5B093DB",
      "advertisingId": "7A3CBEA0-BDF5-11E4-8DFC-AA07A5B093DB",
      "adTrackingEnabled": true,
      "manufacturer": "Apple",
      "model": "iPhone7,2",
      "name": "maguro",
      "type": "ios",
      "token": "ff15bc0c20c4aa6cd50854ff165fd265c838e5405bfeb9571066395b8c9da449"
    },
    "ip": "8.8.8.8",
    "library": {
      "name": "analytics.js",
      "version": "2.11.1"
    },
    "locale": "nl-NL",
    "location": {
      "city": "San Francisco",
      "country": "United States",
      "latitude": 40.2964197,
      "longitude": -76.9411617,
      "speed": 0
    },
    "network": {
      "bluetooth": false,
      "carrier": "T-Mobile NL",
      "cellular": true,
      "wifi": false
    },
    "os": {
      "name": "iPhone OS",
      "version": "8.1.3"
    },
    "page": {
      "path": "\/academy\/",
      "referrer": "",
      "search": "my_search",
      "title": "Analytics Academy",
      "url": "https:\/\/segment.com\/academy\/"
    },
    "referrer": {
      "type": "dataxu",
      "name": "referrer_name",
      "url": "https:\/\/google.com",
      "link": "https:\/\/google.com"
    },
    "screen": {
      "width": 320,
      "height": 568,
      "density": 2
    },
    "timezone": "Europe\/Amsterdam",
    "user_agent": "Mozilla\/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit\/601.1.46 (KHTML, like Gecko) Version\/9.0 Mobile\/13B143 Safari\/601.1"
  },
  "integrations": {
    "All": true,
    "Mixpanel": false,
    "Salesforce": false
  },
  "message_id": "022bb90c-bbac-11e4-8dfc-aa07a5b093db",
  "received_at": "2015-12-10T04:08:31.909Z",
  "sentAt": "2015-12-10T04:08:31.581Z",
  "timestamp": "2015-12-10T04:08:31.905Z",
  "type": "track",
  "user_id": "97980cfea0067",
  "version": 2,
  "event": "Order Completed",
  "properties": {
    "revenue": 25,
    "currency": "USD",
    "value": 4,
    "checkout_id": "fksdjfsdjfisjf9sdfjsd9f",
    "order_id": "50314b8e9bcf000000000000",
    "affiliation": "Google Store",
    "total": 30,
    "shipping": 3,
    "tax": 2,
    "discount": 2.5,
    "coupon": "hasbros",
    "products": [
      {
        "product_id": "507f1f77bcf86cd799439011",
        "sku": "45790-32",
        "name": "Monopoly: 3rd Edition",
        "price": 19,
        "quantity": 1,
        "category": "Games",
        "brand": "Brand",
        "variant": "special",
        "position": 3,
        "coupon": "coupon_code"
      },
      {
        "product_id": "505bd76785ebb509fc183733",
        "sku": "46493-32",
        "name": "Uno Card Game",
        "price": 3,
        "quantity": 2,
        "category": "Games",
        "brand": "Brand",
        "variant": "special",
        "position": 3,
        "coupon": "coupon_code"
      }
    ]
  }
}

Page / Screen

Segment Page

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

Segment.io Field

Zaius Field

properties.path

page

properties.name

name

properties.referrer

referrer

properties.search

search_term

properties.title

title

Email

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

Recommendation: Email Events

If you are already integrating an ESP directly, there is no need to send semantic events for Email as we will capture those directly from the ESP.

Did this answer your question?