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.

Query Params

appId

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.

clientKey

string

required

Defaults to YOUR_DATA_EXPORT_KEY

The Data Export key for your Leanplum App.

apiVersion

string

enum

required

Defaults to 1.0.6

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

Allowed:

audienceName

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.

abTestId

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.

userAttribute

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

Language

Credentials

URL

Response

Choose an example:

application/json

defaultA successful response will return the ID of the export job.