mParticle

Overview

mParticle is a customer data platform that allows you to centralize, manage, and activate your customer and engagement data across any channel.

Use this integration to:

1. Send data from the Split platform as a feed input in mParticle. 
When configured, Split will send traffic impression data for splits to mParticle.

2. Send data to the Split platform as an event output in mParticle.
When configured, Split will quickly process and display mParticle event data in the Split platform for analysis.

This document explains how you can set up and test different configurations within the mParticle integration.

Split as a feed input

In mParticle

Before you begin, within your mParticle account setup Split via the Integration Directory to receive your API Key and Secret and copy and save these 2 strings. mParticle documentation can be found here. 

In Split

1. Go to admin settings, click integrations, select your workspace, and navigate to the marketplace. Click add next to mParticle.
2. Select the environment(s) from where you would like data sent.
3. Select the environment type in mParticle you would your data to be sent to. You can select either:
   
   • Development
   • Production
4. Select how you would like to map Split traffic types to mParticle identities. You can select either:
   
   • customer_id
   • email
   • facebook
   • twitter
   • google
   • microsoft
   • yahoo
   • other
   • other_id_2
   • other_id_3
   • other_id_4
5. Split impressions will be shown as ‘get_treatment’ in mParticle by default or you can customize this event name, with a maximum of 256 characters.
6. Paste the server to server key and secret from your mParticle account and click save.
7. Once you save the configuration, you will be able to send a test event from Split into mParticle.

You can repeat this process depending on how many environments and traffic types you want to configure.

Split as an event output

In Split

1. Go to admin settings and click integrations, select a workspace, and navigate to the marketplace. Click add next to mParticle.
2. Under “configure as an events output in mParticle”, click add configuration.
3. Select the environment in Split you would like your mParticle data to be sent to
4. Map your mParticle identities to your Split traffic types. You can select either:
   
   • customer_id
   • email
   • facebook
   • twitter
   • google
   • microsoft
   • yahoo
   • other
   • other_id_2
   • other_id_3
   • other_id_4
5.  Enable identify to ‘On’ if you want Split to capture the user attributes in your mParticle events via an identify call.
6. Enable events to ‘On’ if you want Split to capture mParticle events being sent to Split.
7. Click save, copy the generated key and use it to configure the events integration settings in mParticle.

In mParticle

Within mParticle, select Split from the integration directory and configure the events integration. When prompted, enter the integration key provided by Split. mParticle documentation can be found here. 

User identity mapping

Logged in and anonymous mapping

If you are planning to map logged in and anonymous traffic we recommend mapping your logged-in traffic type in Split to customer_id in mParticle. For mapping an anonymous traffic type, pass any anonymous ID to Split for targeting and use a other_id field in the user identities to reserve for Split anonymous traffic.

(If you are unsure of which mParticle identifier to map your Split traffic to, please reach out to your mParticle Solutions Consultant or contact support@split.io).

Multiple identity mapping

In general, it is recommended to map a single mParticle identity to a single traffic type in Split. If you require mapping multiple mParticle identities to a single traffic type in Split please contact support@split.io so we can provide guidance on best practices. If an event contains two mParticle identities that are mapped to a single Split traffic type, two events will be generated. For example, if we say we have customer_id = 123 and other= 456 as mParticle identities in an event and both are mapped to user traffic type in Split it will become two events in Split, both with traffic type as user and event one will have key =123 and event two will havekey = 456, other fields will remain the same.

Event data mapping

From mParticle we will accept the following events types:

• commerce event
• custom event
• session start
• session end
• screen view

See the below section to learn more about how fields and properties are mapped in Split for each event type.

Commerce event

For the commerce event, Split accepts product-based events. These events have a product action field populated. Split does not accept promotion-based or impression-based commerce events. If multiple products are included in the product action event, the number of products will be equal to the number of events generated in Split.

Event fields will be mapped as shown below:

mParticle Field	Mapped Field in Split
event type	eventTypeId
eventid	foreignId
timestamp	timestamp
session id source message id	properties
Product action fields: action transaction id total amount tax amount shipping amount currency code affiliation	properties
Location fields: location latitude location longitude location accuracy	properties
Product fields: product id product name product brand product category product variant product position product price product quantity product coupon code product total amount	properties (these fields will be prepended with ‘product.’ in the event property field in Split)
custom attributes	properties (these fields will be prepended with ‘attribute.’ in the event property field in Split)

Custom event

Event fields will be mapped as shown below:

mParticle Field	Mapped Field in Split
event name	eventTypeId
event id	foreignId
timestamp	timestamp
session id source message id	properties
Location fields: location latitude location longitude location accuracy	properties
custom attributes	properties (these fields will be prepended with ‘attribute.’ in the event property field in Split)

Session start event

Event fields will be mapped as shown below:

mParticle Field	Mapped Field in Split
event type	eventTypeId
event id	foreignId
timestamp	timestamp
session id source id	properties
Location fields: location latitude location longitude location accuracy	properties
custom attributes	properties (these fields will be prepended with ‘attribute.’ in the event property field in Split)

Session end event

Event fields will be mapped as shown below:

mParticle Field	Mapped Field in Split
event type	eventTypeId
event id	foreignId
timestamp	timestamp
session id source id	properties
Location fields: location latitude location longitude location accuracy	properties
Other session end fields:  session length ms	properties
custom attributes	properties (these fields will be prepended with ‘attribute.’ in the event property field in Split)

Screenview

Event fields will be mapped as shown below:

mParticle Field	Mapped Field in Split
event type	eventTypeId
event id	foreignId
timestamp	timestamp
session id source id	properties
Location fields: location latitude location longitude location accuracy	properties
Other sessionview fields: screen name	properties
custom attributes	properties (these fields will be prepended with ‘attribute.’ in the event property field in Split)

Please note, Split does not accept the following event types from mParticle:

• uninstall
• crash report
• opt out
• push registration
• application state transition
• push message
• network performance
• breadcrumb