mParticle (export)

Overview

With a push of a button you can send your Branch data to your mParticle dashboard, helping you to understand the power of Branch as an acquisition pathway, export your data to your entire suite of analytics tools and build custom audiences upon Branch data.

This documentation explains how to send Branch events to mParticle. mParticle calls this an Inbound Feed Integration.

If you'd like to send mParticle events to Branch through your app, please review the Branch/mParticle SDK Kit integration documentation for iOS and Android.

If you'd like to send mParticle events to Branch through a server-to-server integration, please review the mParticle (import) documentation.

How does it work?

Once the Branch SDK is integrated into an app, Branch can detect which links lead to installs, re-opens, and users' actions. Enabling this integration and providing your mParticle key/secret will result in Branch automatically forwarding attributed events to mParticle, in the exact format mParticle expects.

What events does Branch send?

Branch will send attributed installs, opens, commerce events, user lifecycle events, content events, and custom events. Branch also sends all the data that is attached to the link that drove the attributed events. This will allow you to analyze which campaigns, channels, etc. are helping you acquire and engage users. You can see the list of fields that we send to mParticle here.

What does it look like?

Branch events will appear as a Custom Attribution Event in mParticle. You can then export Branch data to your other data sources.

Branch events are mapped as follows:

  • mParticle Event Type = Custom Event
  • mParticle Custom Event Type = attribution

The mParticle Event Name depends on the type of event:

  • Install = attribution
  • Open = re-engagement
  • All Others = Branch Event Name

image

For information on how to test your integration and see more detailed data, please review our testing instructions below.

Setup

Prerequisites

Retrieve mParticle Key & Secret

Find your mParticle key & secret and enter it into the Branch Dashboard.

  1. Navigate to https://app.mparticle.com and log into the Dashboard.
  2. In the dashboard, navigate to the Directory and search for Branch .
  3. Click the Branch tile, and click Add Branch Metrics to Setup
  4. Select the Input Feed Integration Type and click Add to Setup

    image

  5. Specify the following configuration parameters:

    • Configuration Name
    • Act as Application (select the right platform here)

      image

  6. Copy your server to server key and secret - you'll enter them into the Branch dashboard in a moment.

    image

Enable the Integration

  1. On the Branch Dashboard (dashboard.branch.io), navigate to the Integrations page.
  2. Search for mParticle and click on the tile.
  3. Enter your mParticle key & secret and hit Enable.

    image

Please test integration!

Branch is not responsible for inaccurate API keys.

Additional mParticle Resources:

You can find additional information about the Branch and mParticle integration in the mParticle documentation.

Advanced

What Branch Sends to mParticle

Property Name Value Sourced from Example
event_name Name of the event hardcoded "attribution"
custom_event_type "attribution" hardcoded "attribution"
event_id Unique ID for the event Branch event ID 469939270182891107
custom_attributes Branch Link Data Dictionary Last Attributed Touch Data for the link to which the event was attributed "campaign": "mParticle test", "channel": "Slack"
timestamp_unixtime_ms timestamp of the event in ms event 1513280479654
device_info Device Data, like OS Version and country Branch User Data for the device "os_version": "10.0","device_country": "US"
user_identities mParticle customer ID mParticle customer ID for the user user123abc
application_info App information like package name Branch SDK/App Details "application_name": "Branch-3rdParty-SDK-Testbed","application_version": "1.2.0"
IP IP of the event Device 192.82.115.928

mParticle Identity Strategy

Branch sends several identifiers to mParticle as part of the webhook payload. Notably, these are:

Identifier Value mParticle Field Example Notes
IDFA Apple's ID For Advertising ios_advertising_id EA7583CD-A667-48BC-B806-42ECB2B48606 Sent with iOS events unless user has Limit Ad Tracking on
IDFV Apple's ID For Vendor ios_idfv 74683E89-E010-4A73-B3ED-2741D4E5FFFE Sent with most iOS events
AAID Android's Android Advertising ID android_advertising_id cdda802e-fb9c-47ad-0794d394c913 Sent with Android events
Android ID Android ID android_uuid 404fc0aea39abcdf Sometimes sent on Android events if AAID isn't present
Customer ID mParticle Customer ID customerid user123abc Customer Identifier mapped from Branch developer_identity

Please ensure your mParticle identity strategy lines up with the identifiers sent by Branch. If it doesn't, mParticle may end up creating new profiles for events sent from Branch rather than attaching these events to the correct existing profiles.

The Customer ID is of particular importance. If you set developer_identity with Branch (docs here), Branch will automatically map this to mParticle's Customer ID. Make sure the value you set here with Branch corresponds to the value you're using for Customer ID in mParticle.

If you're using a different value in developer_identity (for example, MPID), please reach out to your Branch account team.

Testing your integration

To see the data being passed to mParticle in more detail, you can set up a webhook to Requestbin. This will allow you to send only a subset of your Branch events to Requestbin and verify the data is coming through as expected.

  1. Enable the Branch Data Integration above. Install your app from a Branch link to generate some data in mParticle. It can take up to an hour for the custom attributes to show in mParticle.
  2. Create a Branch link from the Quick Links section of the dashboard, with a campaign of branch_test.

    image

  3. In mParticle, navigate to the Directory in mParticle and add Webhooks as an option. Add a Requestbin URL generated from https://requestb.in.

    image

  4. To refine the data being sent to the webhook, navigate to Connections > Connect.

  5. Select the Branch Feed as the input, and Webhooks as the output.
  6. Finally, view the Requestbin. You can do this by appending ?inspect to your requestbin URL. You should be able to copy paste the POST body from the request bin into a JSON formatter like https://jsonlint.com/ to view the event details.
  7. Once you're done testing, delete the webhook.

FAQs

Why doesn't Branch require the mParticle customer ID?

Branch doesn't require the mParticle customer ID because it has usually not been set upon installing the app. The usual workflow for a user is to install the app, then have a confirmed login about thirty seconds later. The Branch install event fires immediately upon install and therefore occurs before the login event, so it does not have the logged-in customer ID before it is sent to mParticle. However, you can join install events for a customer using the device ID attached to the install and login events.

Updated 2 months ago

mParticle (export)


Suggested Edits are limited on API Reference Pages

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