Leanplum's user guides and developer documentation.

Leanplum Documentation

Leanplum's user guides, SDK setup, API docs, and more resources are here to help you get the most out of A/B testing, Campaigns, Messaging, and Analytics.

mParticle Feed

mParticle is a customer data platform that lets marketers integrate and orchestrate data across their entire stack, enabling them to win in key moments in the customer journey.

Configuration

  1. Set up a Leanplum feed configuration in mParticle in order to generate API key and secret values.
  2. Within Leanplum, go to More - Partner Integrations and apply your credentials and mappings in the mParticle configuration page

🚧

Device SystemName is required for the integration to work

When tracking device data in Leanplum, make sure the "SystemName" parameter is sent as described in the start call in our Developer Guide.

Supported event types

We pass Leanplum specific messaging data to mParticle, as Custom App Events with event attributes.

Campaigns

Event

Attributes

Campaign Enter

campaign_id, event_type, name

Campaign Exit

campaign_id, event_type, name

Campaign Forced Exit

campaign_id, event_type, name

Campaign Convert

campaign_id, event_type, name

Campaign Triggered

campaign_id, event_type, name

  • Campaign Name is not available for Lifecycle Campaigns, created from the Messages page.

Push Notifications

Event

Attributes

Push Notification Send

channel, event_type, message_id, name

Push Notification Open

channel, event_type, message_id, name

Push Notification Bounce

channel, event_type, message_id, name

Push Notification Suppressed

channel, event_type, message_id, name

Email

Event

Attributes

Email Send

channel, event_type, message_id, name

Email Delivered

channel, event_type, message_id, name

Email Deferral

channel, event_type, message_id, name

Email Bounce

channel, event_type, message_id, name

Email Open

channel, event_type, message_id, name

Email Click

channel, event_type, message_id, name

Email marked as spam

channel, event_type, message_id, name

Email Unsubscribe

channel, event_type, message_id, name

Email Dropped

channel, event_type, message_id, name

A/B tests

Event

Attributes

A/B test

ab_test_id, variant_id

App inbox

Event

Attributes

App inbox message Open

channel, event_type, message_id, name

App inbox message Send

channel, event_type, message_id, name

In app message

Event

Attributes

In app message View

channel, event_type, message_id, name

Webhook

Event

Attributes

Webhook Send

channel, event_type, message_id, name

Webhook Suppressed

channel, event_type, message_id, name

General

Event

Attributes

Message Send

channel, event_type, message_id, name

Message Open

channel, event_type, message_id, name

Message Held Back

channel, event_type, message_id, name

Attributes

Attribute

Description

ab_test_id

ID of the A/B test in Leanplum

variant_id

ID of the A/B test variant the user was placed into

campaign_id

Unique ID of the reported campaign in Leanplum

channel

Leanplum messaging channel - e.g. "EMAIL", "PUSH"

event_type

Leanplum specific message action (e.g. Open, Send, Bounced)

message_id

Unique ID of the reported message in Leanplum

name

Name of the associated message in Leanplum

Supported identities

User identities

  • Customer ID
  • Email Address
  • Other
  • Other 2
  • Other 3
  • Other 4

Device identities*

  • Android Device ID
  • Apple IDFA
  • Apple IDFV
  • Fire Advertising ID
  • Google Advertising ID
  • Microsoft Advertising ID
  • Microsoft Publisher ID
  • Push Token
  • Roku Advertising ID
  • Roku Publisher ID

Updated 5 months ago


mParticle Feed


Suggested Edits are limited on API Reference Pages

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