Version 1.0 / March 2017

Advertisers use this API to create a set of apps to later be targeted by or excluded from a campaign. This replaces the old whitelist/blacklist API that will soon be deprecated.

Targeting APIs

To use these APIs, send an HTTP request to the following URL:

https://api.applovin.com/applists/command

The following table briefly describes the various command values and their purposes:

Authentication

This API requires that you include an API key as the value of a query parameter (api_key) in the request. You can find this Management Key (formerly called the “Custom Audience Key”) in the Keys tab of your account page. If the Management Key is not visible, please open a ticket here and request one be generated for you. Add this key to your API request in the following way:

https://api.applovin.com/applists/command?api_key=API_KEY

Errors

This API indicates errors by means of HTTP status codes:

create

The first step when you submit an app list is to create an empty list. To create a new list, make an HTTP request to

https://api.applovin.com/applists/create?api_key=API_KEY&name=LIST_NAME

The create API accepts the following fields passed as URL-encoded query parameters

Response:

The response is JSON-formatted:

Example Request:

curl "https://api.applovin.com/applists/create?name=High%20Perfoming%20Apps&api_key=API_KEY"

Example Response:

{"app_list_id" : "fce0b41a0849706bd0fbbe181e61f419"}

list

To get a list of all of the current app lists, make an HTTP request to the list endpoint:

https://api.applovin.com/applists/list?api_key=API_KEY

Response:

The response is JSON-formatted:

Example Request:

curl "https://api.applovin.com/applists/list?api_key=API_KEY"

Example Response:

{
"code": 200,
"app_lists": [
{
"app_list_id": "dab2d1297d35592597b0eee016e92baa",
"name": "High Performing Apps",
"description": "Apps that exceed our ROAS goals",
"app_count": 3
}
],
"count": 1
}

list (with an app list ID defined)

To get the list of all apps in a specified app list, make an HTTP request to the list endpoint with an app_list_id parameter:

https://api.applovin.com/applists/list?api_key=API_KEY&app_list_id=APP_LIST_ID

Query Params:

Response:

The response is JSON-formatted:

Example Request:

curl "https://api.applovin.com/applists/list?api_key=API_KEY&app_list_id=fce0b41a0849706bd0fbbe181e61f419"

Example Response:

{
"code": 200,
"apps": [
{
"application":"a0849706bda0849706bd"
},
{
"application":"4326af2346b2l46e2346"
}
],
"count": 2 }

append

To append apps to an existing list, make an HTTP POST request to:

https://api.applovin.com/applists/append?api_key=API_KEY&app_list_id=APP_LIST_ID

Query Parameters:

Post Body:

The append endpoint accepts a newline-separated list of IDs in a POST request:

Response:

The response is JSON-formatted:

Example Request:

curl -X POST --data-binary @apps.txt "https://api.applovin.com/applists/append?app_list_id=APP_LIST_ID&api_key=API_KEY"

Where the contents of the file apps.txt is:

a0849706bda0849706bd
4326af2346b2l46e2346

Example Response:

{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }

delete

To delete an app list, make an HTTP request to

https://api.applovin.com/applists/delete?api_key=API_KEY&app_list_id=APP_LIST_ID

Query Parameters:

Response:

There is no response body for the delete endpoint. On success it returns HTTP Response code 200.

Example Request:

curl "https://api.applovin.com/applists/delete?app_list_id=APP_LIST_ID&api_key=API_KEY"

deleteApps (remove apps from a list)

To delete apps from an existing list, make an HTTP POST request to:

https://api.applovin.com/applists/deleteApps?api_key=API_KEY&app_list_id=APP_LIST_ID

Query Parameters:

Post Body:

The append endpoint accepts a newline-separated list of IDs in a POST request.

Response:

The response is JSON-formatted:

Example Request:

curl -X POST --data-binary @apps.txt "https://api.applovin.com/applists/deleteApps?app_list_id=APP_LIST_ID&api_key=API_KEY"

Where the contents of the file apps.txt is:

a0849706bda0849706bd
4326af2346b2l46e2346

Example Response:

{ "app_list_id" : “dab2d1297d35592597b0eee016e92baa”, "processed_apps" : 2, "failed_apps" : 0 }

Targeting Campaigns to an App List

Once an app list is created and has apps associated with it, it will appear as an option in the Application section of the Edit Targets page for all campaigns.

Example Postman Collection:

• AppLovin App Lists.postman_collection.json3 KB