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 install events to mParticle. mParticle calls this an Inbound Feed Integration. If you'd like to send mParticle events to your Branch dashboard through your app, please review the Branch/mParticle SDK Kit integration documentation for iOS and Android. At present there is no server to server integration for sending mParticle data to Branch.
How does it work?¶
Once the Branch SDK is integrated into an app, Branch can detect which links are leading to installs, re-opens, and users' actions. Enabling this integration and providing your mParticle key/secret will result in Branch automatically forwarding attributed installs to mParticle, in the exact format mParticle expects.
What events does Branch send?¶
Branch will send attributed installs. Branch also sends all the data that is attached to the link that drove the attributed installs. 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 an attribution event in mParticle. You can then export Branch data to your other data sources.
Branch attribution events are mapped as follows:
- Event Type = Custom Event
- Custom Event Type = attribution
- Event Name = attribution
For information on how to test your integration and see more detailed data, please review our testing instructions below.
- This guide requires you to have already integrated the Branch and mParticle mobile SDK(s).
- This guide requires you to have the AdSupportFramework on iOS and Google Play Services library on Android.
Retrieve mParticle Key & Secret¶
Find your mParticle key & secret and enter it into the Branch Dashboard.
- Navigate to https://app.mparticle.com and log into the Dashboard.
- In the dashboard, navigate to the Directory and search for Branch .
- Click the Branch tile, and click Add Branch Metrics to Setup
Select the Input Feed Integration Type and click Add to Setup
Specify the following configuration parameters:
- Configuration Name
- Act as Application (select the right platform here)
Copy your server to server key and secret - you'll enter them into the Branch dashboard in a moment.
Configure Branch Dashboard¶
Enable Data Feeds¶
Data Integrations are included as part of the Data Feeds product. For more information on Data Feeds, and how to enable it, please read the Data Feeds summary.
Select the integration¶
- Navigate to Data Integrations within Data Feeds.
Find the integration you need by typing in the search box.
We've upgraded our Data Integrations!
We've upgraded our Data Integrations to use people-based attribution. If you see the below screen instead of the screenshot above, please click "Preview Now" to upgrade to our updated integrations. We will be deprecating our legacy integrations in 2018.
On the Branch Dashboard (dashboard.branch.io), navigate to the Integrations page.
- Search for mParticle and click on the tile.
Enter your mParticle key & secret and hit Enable.
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.
What Branch Sends to mParticle¶
| Property Name | Value | Sourced from | Example | --- | --- | --- | --- | --- | --- | event_name | "attribution" | hardcoded | "attribution" | custom_event_type | "attribution" | hardcoded | "attribution" | event_id | Unique ID for the event | Branch install event ID | 469939270182891107 | custom_attributes | Branch Link Data Dictionary | Last Attributed Touch Data for the link to which the install 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 (mostly empty) | mParticle customer ID for the user | firstname.lastname@example.org | 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 | 18.104.22.1688
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.
- 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.
Create a Branch link from the Quick Links section of the dashboard, with a campaign of branch_test.
In mParticle, navigate to the Directory in mParticle and add Webhooks as an option. Add a Requestbin URL generated from https://requestb.in.
To refine the data being sent to the webhook, navigate to Connections > Connect.
- Select the Branch Feed as the input, and Webhooks as the output.
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.
Once you're done testing, delete the webhook.
Why does Branch only send installs to mParticle?¶
At this time, the mParticle Inbound Feeds product only supports attributed events via their attribution custom event. This is currently limited to installs. However, please reach out to your Branch or mParticle Account Manager if this limitation prevents you from doing the analysis you need.
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.