HomeUser GuideDeveloper GuideChangelog
Developer Guide

exportUsers

get
https://api.leanplum.com/api?action=exportUsers

Exports multiple user IDs. The export may be executed up to 40 times successfully per day, and this limit resets at 12:00 am PST each calendar day. This method requires your data export API clientKey.

Use getExportResults with the returned jobId to get the results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Example exportUsers request: Exporting a saved audience

To export one of your audiences of users, use the audienceName param option. The full call would look something like:

https://api.leanplum.com/api?action=exportUsers&appId=YOUR_APP_ID&clientKey=YOUR_DATA_EXPORT_KEY&apiVersion=1.0.6&audienceName=My test audience

Once your request is successful, you'll get a jobId. Use this ID with the getExportResults call to get your final user list as a CSV.

Query Params
string
required
Defaults to YOUR_APP_ID

The application ID. To find yours, select your app in the navigation column, and click Manage Apps. Then click Keys & Settings.

string
required
Defaults to YOUR_DATA_EXPORT_KEY

The Data Export key for your Leanplum App.

string
enum
required
Defaults to 1.0.6

The version of the Leanplum API to use. The current version is 1.0.6.

Allowed:
string

Export users in a particular audience. Use the audience name as seen on your audience dashboard. If skipped, Leanplum will export all users, unless other filters are applied.

number

Limit export to only users that are in the given A/B test. The output will include the variant ID and name for each user.

string

Export users with a specific attribute set. The export results will include the userId and attribute value for each user. For example, userAttribute email would export all email users along with their email addresses.

Response

Updated 10 months ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago