Leanplum's user guides and developer documentation.
User Guide
Developer Guide
{{user.name}}
Log In
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
Home
User Guide
Developer Guide
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
User Guide
Developer Guide
Changelog
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.projectName ? 'in ' + result.projectName : ''}}
{{result._method}}
Reference {{result.projectName ? 'in ' + result.projectName : ''}}
Changelog {{result.projectName ? 'in ' + result.projectName : ''}}
Discussions {{result.projectName ? 'in ' + result.projectName : ''}}
Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results
Onboarding
Leanplum Help Center
Initial setup
Set up push notifications
Importing historical push tokens
Leanplum iOS SDK binary size
Which device ID format should I use?
Start tracking with Leanplum
Adding receipt verification for in-app purchases
Enabling uninstall tracking
How to enable Leanplum Activity Feed
Testing and QA best practices
Use the right API keys
Setting up separate staging and live environments
Previewing content in Leanplum
Register your test device
Use Leanplum variables
Importing data into Leanplum
Import user data with a CSV file upload
Prepare a CSV file to import user data
Bulk delete user attributes with a CSV file
Bulk delete Users from the dashboard
CSV upload troubleshooting
Exporting data
Exporting raw data via the API
Reading and Understanding exported sessions data
Managing files
Glossary
Campaigns
Campaigns overview
Campaign basics
Re-engage dormant users
Goal
Audience
Build a segment
Save a segment
Audience Estimator
Time-related segment operators
Segmentation options
Delivery
Geofence triggers
Actions
Sub-Delivery
Sub-Audience
Images in messages
Preview an action
Add multiple actions
Make buttons trigger another action
Summary
Results
Campaign Flow
Campaign Actions
Push notifications
Android notification channels
Customize push notifications for Android
In-app messages
Confirm message
Center popup message
Alert message
Web interstitial message
Push pre-permission message
Interstitial message
Floating Interstitial message
Banner message
Satisfaction Survey message
App inbox messages
Webhook
App function
Personalize an action
Customize in-app messages with HTML
A/B test your actions
Email
Email setup
IP warmup
Set up IP warmup user attributes
Email best practices
Set up a DMARC policy
Set up SSL for click tracking
Send an email campaign
Drag and Drop email editor
HTML Email Editor
Send a universal link in Email
Add custom fonts for email
Preview and test email
Managing email templates
Manage email subscriptions
Identifying unsubscribed users
Email analytics
Analyze clicks and bounces in an email campaign
Analyze email metrics by domain
Email troubleshooting and FAQ
Messaging
Messaging basics
Create a message
Choosing a message type
Message statuses
Personalize a message
Testing a personalized message
Localize message copy
Linked Data
Choose a delivery method
Limit message sends
Preview a message on your test device
In-app messages
Alert message
Confirm message
Center popup message
Push Pre-Permission message
Interstitial message
Web interstitial message
App review request
In-app message active periods (beta)
How to find missing in-app message and action templates
Image specs for messages
Rich in-app messages
Banner message
Rich interstitial message
Star rating message
Add custom fonts to messages
App inbox messages
Push notifications
Sending a push before or after a time-based event parameter or user attribute
Sending a manual push notification
Analyzing push opt-ins
Message users when they enter or exit a geofence region
Adding images to push notifications
Web push notifications
Push notification troubleshooting and FAQ
Push notifications are not sending
Setup: Email messaging
IP warmup
Set up IP warmup user attributes
Manage email subscriptions
Email
Email best practices
Email templates
Add a preheader as Hidden Preheader Text
Localize email content
Send a universal link in Email
Identifying unsubscribed users
Set up SSL for click tracking
Set up a DMARC policy
Email troubleshooting and FAQ
Webhooks
Message goals
Adding a Holdback to your message
Lifecycle Campaigns
Lifecycle Campaigns and regular messages
Copy a Lifecycle Campaign
Messaging FAQ
A/B tests
A/B test basics
Creating an A/B Test
Setting test goals
Targets for A/B tests
Using impression criteria
Estimating test completion date and making changes
Add and edit content for each test group
Setting the distribution for control and variants
Preview an A/B test on your device
Finish your test and select the winning variant
A/B testing a message
Pause, copy, or delete your test
Gradually rolling out A/B tests to your audience
Restore previous versions of A/B tests, variables, or messages
Export user IDs in a live A/B test (experiment) by control and variant
A/B tests FAQ
Creating an A/A test & interpreting results
When are users assigned to tests and messages?
A/B testing error messages
A/B test best practices
Analytics
Analytics overview
User analytics (general)
Reports
Filter data
Group or cohort data
Graph display options
Chart annotations
Metrics
User metrics
Engagement metrics
Retention metrics
Monetization metrics
Funnels
Stacks (combine metrics)
Custom metrics
Event metrics
State metrics
Unique user metrics
Leanplum events
A/B test analytics
Lifecycle Campaign analytics
Push notification analytics
In-app message analytics
Email analytics
Analyze clicks in an email campaign
Analyze bounces in an email campaign
Analyze email metrics by domain
Export analytics data
Analytics FAQ
Users and targeting
Look up and filter user information
Find a specific User ID
Find users who received a message, campaign, or test
User profile
Building segments and targets
Segment and target options
Segment operators
Stickiness and targets
How and when are targets evaluated?
Time-related targeting operators
Segmenting to multiple values for a given target
User ID List targeting (beta)
Saved segments
Using email behavior as targeting criteria
Users and targeting FAQ
Variables
Adding variables
Previewing changes on your test device
Syncing variables to Leanplum
When are content changes synced to user’s apps?
Change a user's App Icon (iOS 10.3+)
Preserve variables
Variables FAQ
App Settings
Account and team settings
Custom team roles and permissions
Single sign-on with SAML 2.0
App settings
Debugger
Partner integrations
How to integrate external Attribution services
Adjust integration
Affirm integration
Amplitude integration
Appsflyer integration
Apteligent integration (crash reporting)
Branch.io integration
BriteVerify integration
Foursquare integration
Inkit Integration
Marketo integration
mParticle
mParticle Event
mParticle Audience
mParticle Feed
Plot Projects integration
Radar integration
Segment
Segment Source
Segment Destination
Segment SDK integration
Tealium integration
Tune integration
Twilio integration
InMobi integration
Technical Tutorials
Onboarding and integration
Leanplum first basic instrumentation and registering for push [Sample: iOS, Android, Unity]
How Leanplum SDKs work
Handling logins with UserIDs
Securing your Leanplum API keys
Migrating to Firebase
Structuring the App: Handle same User login on different devices
Instrumenting variables [Sample: iOS, Android]
User attributes and events for segmenting messaging campaigns
Updating your app to support App Icon Change (iOS 10.3+)
Delete and deprecate events
Push guides and how-to's
How to test a Push Pre-Permissions message
Setting up Geofencing for triggering Push Notifications
Customize your push notifications [Sample: Android]
Rich push setup
Using custom key-value pairs sent within a push notification
Message templating {{
Control Structures
Expression Tests
Built-in Filters
Functions
Built-in variables
Expressions
Leanplum templating language
Doing math with dynamic values
Technical FAQ
Troubleshooting
General troubleshooting
Email preview doesn't generate correctly
Unexpected users in A/B test
How to generate a new device ID for iOS
Guides and Tips
How to get more five-star app ratings
How to reduce shopping cart abandonment
How to increase user registrations with onboarding reminders
How to increase push notification opt-ins
How to delight users by recognizing achievements
How to reward your loyal customers
How to encourage early monetization to drive customer lifetime value
How to increase holiday spend
How to increase revenue with upsells and cross-sells
How to speed up the app update process
How to announce new features
How to drive daily active users with time-based reminders
How to reduce one-time user drop-off
How to re-engage dormant users
Videos
Support
SDK Documentation
SDK Introduction
iOS setup
Android setup
Unity setup
JavaScript setup
React Native setup
Manual SDK setup
Manual setup iOS
Manual setup Android
Variables
Variable types
Modeling structured data
Callbacks
Syncing with Leanplum mid-session
Event and parameter tracking
State tracking
User and device tracking
Device IDs
User IDs
User attributes
Sessions
In-app messaging
Customizing in-app message templates
Sending iOS 10.3+ app review requests
Push notifications
iOS push notifications
Android push notifications
Unity push notifications
JavaScript push notifications
ReactNative push notifications
App inbox
Geofencing and location-based messaging
iOS location services
Android location services
React Native location services
How to integrate external Attribution services (App setup)
API Documentation
API Introduction
Making requests
Authentication
Selecting a user
Responses
Billing
Batching requests with multi
Reduce billable requests
Debugging
API methods
User Behavior
post
advance
post
pauseState
post
resumeState
post
pauseSession
post
resumeSession
post
heartbeat
post
start
post
stop
post
track
User Information
post
setUserAttributes
post
setDeviceAttributes
post
setTrafficSourceInfo
post
registerDevice
post
deleteUser
post
block
post
unblock
Messages
get
getMessage
get
getMessages
get
getUnsubscribeCategories
post
sendMessage
post
addAndroidNotificationChannel
get
getAndroidNotificationChannels
post
deleteAndroidNotificationChannel
A/B Tests
get
getAbTest
get
getAbTests
get
getVariant
Files and Variables
get
getVars
post
setVars
post
deleteVars
get
downloadFile
post
uploadFile
Export Data
post
addPostback
get
listPostbacks
post
deletePostback
get
exportData
exportData schema (csv, S3 bucket)
get
exportReport
exportData schema (JSON)
get
exportUser
get
exportUsers
get
getExportResults
Import Data
post
multi (CSV)
multi (JSON)
get
getMultiResults
API Limits
API guides
Creating new users with our API
Sending messages manually via the API
Setting attribution source data via the API
Exporting bookmarked reports
Exporting Leanplum in-app message events to other analytics providers
Exporting Leanplum A/B test info to other analytics providers
Export Raw Data via Python Scripts [Sample: API]
Accessing content via the API
Tracking analytics data via API
Interpreting metrics in raw data export files
Calculate DAU with the raw data via Python
GDPR overview
Email setup
Suggest Edits
Updated 2 months ago
Next
Manage email subscriptions
IP warmup
Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}
Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}
Email setup
Suggested Edits are limited on API Reference Pages
You can only suggest edits to Markdown body content, but not to the API spec.
Updated 2 months ago