HomeUser GuideDeveloper GuideChangelog
User Guide

Amplitude Feed

Suggest Edits

When you activate the Amplitude Feed, Leanplum will automatically stream all Leanplum specific marketing events to your Amplitude project. All events will be tagged with the User ID and Device ID associated with the user at the time of the event.

Configuration

  1. In Amplitude, navigate to Settings > Projects and select the relevant project.
  2. On the General tab, locate the API key and copy it to your clipboard.
  3. In the Leanplum dashboard, navigate to the Data Control tab and select Partner Integrations.
  4. Search for Amplitude from the list, and click Configure Integration.
  5. Under the Output section, paste your Amplitude project’s API key into the Token box.
    Click Save.

Make sure your user identities are matching in Leanplum and Amplitude. Otherwise, the integration may create data discrepancies.

🚧

Anonymous users

In case the user is anonymous, the User ID will be left blank and only Device ID will be passed to Amplitude.

Email Events

The following email events will be sent to Amplitude with the respective properties:

Email Send

{
  "event": "(Leanplum) Message Send",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Email"
  },
}

Email Delivered

{
  "event": "(Leanplum) Message Delivered",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Email"
  },
}

Email Open

{
  "event": "(Leanplum) Message Open",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Email"
  },
}

Email Bounce

{
  "event": "(Leanplum) Message Bounce",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Email"
  },
}

Email Clicked

{
  "event": "(Leanplum) Message Click",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Email"
  },
}

Email Marked as spam

{
  "event": "(Leanplum) Message Marked as spam",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Email"
  },
}

Email Unsubscribed

{
  "event": "(Leanplum) Message Unsubscribed",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Email"
  },
}

Push Events

The following push events will be sent to Amplitude with the respective properties:

Push Notification Send

{
  "event": "(Leanplum) Message Send",
  "properties": {
    "time": "timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Push"
  },
}

Push Notification Open

{
  "event": "(Leanplum) Message  Open",
  "properties": {
    "time": "timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Push"
  },
}

Push Notification Held Back

{
  "event": "(Leanplum) Message Held Back",
  "properties": {
    "time": "timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "Push"
  },
}

In-app Events

The following in-app events will be sent to Amplitude:

In-app Message View

{
  "event": "(Leanplum) Message View",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "In-app Message"
  },
}

In-app Message Held Back

{
  "event": "(Leanplum) Message Held Back",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "In-app Message"
  },
}

In-app Message Accept

{
  "event": "(Leanplum) Message Accept",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "In-app Message"
  },
}

In-app Message Submit

{
  "event": "(Leanplum) Message Submit",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "In-app Message"
  },
}

In-app Message Select

{
  "event": "(Leanplum) Message Select",
  "properties": {
    "time": "Timestamp of the event",
    "message_id": "Leanplum Message ID"
    "campaign_id": "(optional) Leanplum Campaign ID",
    "message_name": "Leanplum Message Name"
    "campaign_name": "(optional) Leanplum Campaign Name",
    "channel": "In-app Message"
  },
}

A/B Testing Events

For A/B tests, we will send the following event to Amplitude:

A/B Test Impression

{
  "event": "(Leanplum) A/B Test Impression",
  "properties": {
    "time": "Timestamp of the event",
    "AB Test ID": "Leanplum A/B test ID",
    "Variant ID": "Leanplum A/B test Variant ID"
  },
}

Updated over 2 years ago