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.

Campaigns FAQ

When do users "enter" a campaign?

A user only counts as having entered a campaign after they receive the first action of that campaign.

For example, if your overall audience was Android users, but your first action was set to deliver to users who reach level 5 of your game, Android users who are only at level 3 won't count as having entered your campaign in Analytics.

See the Metric glossary for more on how "enter" events are calculated.

When and how do users leave a campaign?

When users stop qualifying for actions.
Users fall out of the campaign when they aren't eligible to receive the next action in the campaign. For example:

  • If the next action is a push notification but the user doesn't have push enabled
  • If the campaign is targeted to San Francisco residents but the user moves or travels
  • If the next action has a sub-audience the user doesn't qualify for

Users who stop qualifying for actions move into the attribution window, where their conversion will still be counted toward the campaign's Analytics. Keep in mind, users can re-enter a campaign after the attribution window if they complete the entry trigger again.

When you end the campaign.
When you click "End Campaign" on the Summary tab, it brings a hard stop to your campaign. No more actions will be delivered, and the attribution window will immediately end for all users (meaning no more conversions will be counted toward this campaign).

When the End Date & Time passes.
Once the End Date & Time passes (if you set one), new users will no longer be able to enter the campaign, while users already in the campaign will stop receiving actions and will be pushed into the attribution window.

If you forgot to add an End Date & Time before starting your campaign, you can add one after it's live (to trigger campaigns only). Go to the live campaign's Delivery tab, add your end date, and click "Publish Changes."

How is Optimal Time calculated?

Optimal Time is calculated based on users' previous sessions, country information, and default timezone.

For emails, Optimal Time is based on users' open and send rates for emails from your domain. If a user doesn't have any email open or send data yet, Leanplum will send the email using your domain's average email open time.

❗️

Avoid message send failures with Optimal Time

Users who don't have previous app session data (such as newly-imported users) may not receive Optimal Time campaigns, since Leanplum won't have enough data to calculate their Optimal Time.

To avoid message send failures:

  • Contact your CSM to set a default timezone for users with 0 sessions.
  • Schedule campaigns with UTC Time for the first month you use Leanplum.

What if a user's Optimal Time has passed?

If you schedule a same-day campaign, some users' Optimal Times may have already passed. In this case, the message will send immediately (unless Quiet Hours are enabled). We recommend sending optimal time campaigns at least one full day in advance for this reason.

Keep in mind, emails must be scheduled at least one hour in advance.

Updated about a year ago


Campaigns FAQ


Suggested Edits are limited on API Reference Pages

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