The purpose of this guide is to walk you through the basic steps of setting up mParticle in your app, unlocking core functionality, and troubleshooting common issues. Along the way, you’ll cover some important concepts you need to understand to be successful with mParticle.
This is not a complete guide to all of mParticle’s features and capabilities. If you already know your way around mParticle and you’re looking for in-depth docs, head to our Developers or Guides sections.
The tutorials in this guide follow the process of setting up mParticle in the mPTravel app: a mobile and web app that sells luxury travel packages to its users.
Later on in this guide, you’ll learn about sending data from mParticle to some of our many integration partners. As examples, the tutorials use services which are simple to set up and verify, and which offer a free account tier, so that you will be able follow the examples exactly if you wish. However, mParticle is agnostic about which integrations you choose and you can follow the same basic steps from this guide to implement any of our integrations.
Inputs and Outputs
One of the key functions of mParticle is to receive your data from wherever it originates, and send it wherever it needs to go. The sources of your data are called “inputs” and the places it needs to go are “outputs”.
Examples of an input can include:
Native app - iOS or Android mobile app
Web app - mobile or desktop web
Data feed - any other data you want to send into mParticle. This could be data you have collected yourself or from a Feed partner.
Examples of an output can include:
Analytics partners, like Amplitude
Advertising partners, like Facebook
In-app messaging partners, like Braze
Data Warehouse partners, like Amazon Redshift
To get started with mParticle, you need some data, which means you need to create at least one input.
Create Access Credentials
The first thing you need to do is to to create a set of access credentials that will allow a client-side SDK or a server-side application to forward data to this workspace.
Login to your mParticle account. If you’re just getting started, your first workspace is created for you. The first screen you see is an overview of activity in the workspace. Since you haven’t yet sent any data, there’s nothing to report, so far.
Navigate to Setup > Inputs in the left column. Here you can see each platform type accepted by mParticle. Different platforms are associated with different sets of metadata, such as device identifiers, and most outputs only accept data from a limited set of platforms, so it is important to select the right platform. To capture data from your native Android app, choose Android. Just click the + next to your chosen platform.
Click Issue Keys.
Copy and save the generated Key and Secret.
About Access Credentials
mParticle labels the credentials you create for an integration the key and secret, but they are not exactly like an API key and secret, since you embed these credentials in the app. However, this is not the security risk that exposing API credentials would be:
The client-side key and secret can’t read data from the system.
You can block bad data to stop any traffic that doesn’t match the data you expect as defined in your schema.
Most anonymous client-server architectures, including Adobe, Braze, Firebase, Google Analytics, and Segment don’t have per-session or per-instance credentials, nor does mParticle.
Install and Initialize an mParticle SDK
Verify: Look for Incoming Data in the Live Stream
Navigate to Activity > Live Stream in the left column. The Live Stream lets you inspect all incoming data from your development environments. It’s an easy way to check that you’ve correctly initialized mParticle in your app. When you first open up the Live Stream, it will be empty, as we haven’t yet started sending data.
Start up a development build of your app (get a developer to help you if necessary). The mParticle SDKs automatically collect and forward data about installs and user sessions, so just by opening a development build of your app, you should start to see data in the Live Stream.
If you don’t see data appearing in the Live Stream within the first few minutes after opening a development build:
Check that you have copied your Key and Secret correctly
Check that you have properly included the mParticle SDK in your project and it is correctly initialized. The necessary steps will differ depending on the platform. Check our iOS, Android and Web docs for more.