Built-in variables

Leanplum variables

Leanplum includes many predefined variables to access user profile data. New variables may be added over time. To preserve compatibility, any custom variables you declare have precedence over the built-in variables.

Behavioral data

Includes information about a user’s activity, such as what events and states they have triggered. These variables are contextual, and evaluated for each user.

A gaming app could, for example, include personalized information about a user's high scores in their message:

{{ userAttribute['Player name']}}, 
congrats on your level 14 score of {{valueOf['level14']}}!!

You now have {{lifetimeValue['totalCoins']}} total coins. 

Ready for level 15?

Lifecycle data

Includes information about when and how often a user is engaging with your app.

Localization data

Localization data include the user’s location and localization preferences.

Technology data

Includes information about the user’s current device.

Traffic Source data

Includes information about where your users came from when installing your app. To use these, you need to set up an integration with one of our attribution partners. See partners.

User data

Includes the user’s ID and custom attributes.

Contextual data

For triggered messages, contextual variables are used to access information about the trigger that activated the message. For example, a shopping cart abandonment message could be triggered by an “Add to Cart” event. This event may contain parameters including the item, quantity, and price of the item that was added to the cart.

Messages sent via the sendMessage API

🚧

Null values sent through the sendMessage API will insert the key as a string.

If values sent through the sendMessage API /Manual delivery evaluate to null or the key is missing in the sent JSON values, the value will equal the string of the key. Examples:

Jinja code used:
{{value['value1']}}

Values sent:

1. For a correct value passed in the API call
   {"value1": "some text"}
   The text "some text" will be inserted.

2. For a null value
   {"value1": null}
   The text "value1" will be inserted.

3. If no value is passed
   {}
   The text "value1" will be inserted.

To handle this behavior correctly, try the following condition:
{% set v = value['value1'] %}
{% if v and (v != "value1") %}
Value1 is not null. The value passed is: {{v}}
{%else%}
Value1 is null.
{% endif %}

Scheduled server-side messages

Triggered server-side messages

In-app messages

🚧

In-app message limitations for contextual values.

For in-app messages, the contextual values above cannot be used with advanced jinja features such as if-statements, for-loops, or filters. The values above can only be printed, e.g. {{previousValue}}.

Linked data variables

Linked data allows you to connect your user profile data with data stored in other sources, like in your own data warehouse or within another service provider. Some examples of linked data include real-time information such as whether an item is in stock, whether a flight is on time or delayed, weather forecasts, or inferred demographic data based on the current user’s attributes.

You can set up linked data sources in your app settings on the Leanplum dashboard. Linked data sources have a name and a URL of the source. The URL itself can be a Leanplum template, which can in turn include other information from a user’s profile. The URL may also include empty placeholders ({}) which must be filled in when accessing the data source.

All linked data is accessible from the linkedData variable:

Examples

Menu

You may have a “menu” data source which emits the following JSON:

{
  "date": "March 10, 2016",
  "items": [
    {
      "name": "Lasagna",
      "image": "http://mydomain.com/images/1001.jpg",
      "price": 11
    }, {
      "name": "Ravioli",
      "image": "http://mydomain.com/images/1002.jpg",
      "price": 12
    }, {
      "name": "Pizza",
      "image": "http://mydomain.com/images/1003.jpg",
      "price": 10
    }
  ]
}

To render the menu in a template, you may use the following markup:

{% for item in linkedData.menu.items %}
  <div>
    <h2>{{ item.name }}: ${{ item.price|round(2) }}</h2>
    <img src="{{ item.image }}" />
  </div>
{% endfor %}

Product pricing

You may have an “item” data source with a parameter for the item SKU, which looks up information about a particular product.

{
  "inStock": true,
  "price": 39.99
}

You can display the price of an item with this template:

The price of the item is 
{{ linkedData.item[parameter.itemSku].price|numberformat('$#,###.00') }}.

Handle missing Data

In the above example, if there was a problem retrieving the data, the price would be null. Leanplum will automatically skip sending the message if a null value is rendered within a message.

In the next example, we display if the item is in stock. Here, we are not rendering a null value, so we need to explicitly skip the message using skipmessage().

{% set item = linkedData.item[parameter.itemSku] %}
{% if item == null %}
 {{ skipmessage() }}
{% elif item.inStock %}
 Your item is in stock at {{ userAttribute.preferredStore }}!
{% else %}
  Your item is not in stock at this time. 
  We’ll notify you when it becomes available.
{% endif %}