Version 1.0 / March 2017
This API can be used by advertisers 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.
The available app targeting APIs are
List – Displays the current apps lists or the defined apps on a particular list
Create – For creating a new app list
Append – Add new apps to an existing list.
Delete – Deletes a given app list.
Delete Apps – Removes given apps from a specific list.
Authentication:
This API requires an API key to be given as a query parameter in the request. The Management Key (formerly called the Custom Audience Key) can be found in the 'Keys' tab of the advertiser's account page. If the Management Key is not visible, email AppLovin support at adsupport@applovin.com and one will be generated.
https://api.applovin.com/applists/list?api_key=<API_KEY>
Errors:
Http status codes are used to indicate errors.
HTTP Response Code
|
Description
|
200 |
Success |
400 |
Request was not formatted properly, was missing data or had invalid data. |
403 |
Authentication failed. Check the validity of the API Key |
404 |
App List ID specified does not exist |
406 |
For create, an active list with the same name exists already. |
500 |
Service Unavailable. |
Create:
The first step to submitting 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>
The create API accepts the following fields passed as URL encoded query parameters
Name |
Type |
Description |
Required |
name |
String |
Name of the list |
yes. Must be alphanumeric, _-+, or URL encoded space |
description |
String |
Description of the list |
no |
The response is a JSON formatted response:
Name |
Type |
Description |
app_list_id |
String |
ID of the audience |
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 the current app lists make an HTTP request to the list API.
https://api.applovin.com/applists/list?api_key=<API_KEY>
The response is a JSON formatted response:
Name |
Type |
Description |
code |
int |
200 for success |
app_lists |
List of Objects |
A list of objects containing information about an app list |
app_list_id |
String |
ID of the list |
name |
String |
Name of the list |
description |
String |
Description of the list. |
app_count |
Long |
Number of apps that are part of the list |
count |
Long |
Number of lists returned |
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 API with an app_list_id parameter.
https://api.applovin.com/applists/list?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
Query Params:
Name |
Type |
Description |
Required |
app_list_id |
String |
ID of the app list returned from the create or list API. |
yes |
The response is a JSON formatted response:
Name |
Type |
Description |
code |
int |
200 for success |
apps |
List of Objects |
A list of objects containing all apps in the list |
application |
String |
External Application ID |
count |
Long |
Number of apps that are part of the list |
Example Request:
curl "https://api.applovin.com/applists/list?api_key=<API_KEY>&app_list_id=fce0b41a0849706bd0fbbe181e61f419"
Example Response:
{ "code": 200, "apps": [ { "application":"
a0849706bd
a0849706bd
"
},
{
"application":"4326af2346b2l46e2346"
}
],
"count": 2 }
Append:
To append apps to an existing list, make an HTTP POST to
https://api.applovin.com/applists/append?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
Query Params:
Name |
Type |
Description |
Required |
app_list_id |
String |
ID of the app list returned from the create or list API. |
yes |
Post Body: The append API accepts a new line separated list of ids in a POST request
Name |
Type |
Description |
Required |
List of apps |
List of Strings |
A new line separate list of external app IDs |
yes |
The response is a JSON formatted response:
Name |
Type |
Description |
app_list_id |
String |
ID of the app list |
processed_apps |
Integer |
Number of valid apps in this request. |
failed_apps |
Integer |
Number of invalid apps in this request. |
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
a0849706bd
a0849706bd
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 Params:
Name |
Type |
Description |
Required |
app_list_id |
String |
ID of the app list returned from the create or list API. |
yes |
There is no response body for the delete API. On success HTTP Response code 200 is returned.
Example Request:
curl "https://api.applovin.com/applists/delete?app_list_id=<APP_LIST_ID>&api_key=<API_KEY>"
Delete Apps (Remove apps from a list):
To delete apps from an existing list, make an HTTP POST to
https://api.applovin.com/applists/deleteApps?api_key=<API_KEY>&app_list_id=<APP_LIST_ID>
Query Params:
Name |
Type |
Description |
Required |
app_list_id |
String |
ID of the app list returned from the create or list API. |
yes |
Post Body: The append API accepts a new line separated list of ids in a POST request
Name |
Type |
Description |
Required |
List of apps |
List of Strings |
A new line separate list of external app IDs |
yes |
The response is a JSON formatted response:
Name |
Type |
Description |
app_list_id |
String |
ID of the app list |
processed_apps |
Integer |
Number of apps deleted from the list in this request. |
failed_apps |
Integer |
Number of invalid apps in this request. |
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
a0849706bd
a0849706bd
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.