At a glance: Ad networks can retrieve metadata of apps associated with their integrated partner account.
Get app list API
The following sections include information necessary for using the API.
Get app list basics
| Category | Item |
Description |
|---|---|---|
| Request | HTTP method | GET |
| Path |
https://hq1.appsflyer.com/api/mng/apps |
|
| Authorization header |
|
|
|
Response |
Results |
Return in a JSON |
| Request limit |
|
|
| Record limit |
1,000 records/request. If more than 1,000 records are to return, use follow on pagination requests, described in this article. |
API request
The API request consists of the method, path, mandatory capabilities parameter, and optional pagination parameters. The token is contained in the authorization header.
Method
GET https://hq1.appsflyer.com/api/mng/apps?capabilities={capabilities} |
Query parameter |
Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| capabilities |
To get the list and number of apps to which you have permission/integration capabilities: set the capabilities parameter to one of the options listed.
Example: List of apps for which you have Protect360 report API permission: |
Pagination mechanism
A pagination mechanism, always operational, is implemented.
Pagination principles:
- Returns up to 1,000 records per request (page).
- Response JSONs contain the following pagination related keys:
- meta.total_items: The number of records to be returned by all pages combined. This represents the number of apps for which you have been granted the capabilities being queried.
- Pagination links (depicted in the JSON that follows) have the following keys:
- links.prev: If there was a previous request: the request used to generate the previous page.
- links.self: The current request: the request used to generate the current JSON (page)
- links.next: The request required to get the next page. If there is no next key, this is the last page.
Use one of the following pagination control methods:
- [Best practice] Use the links in the JSON: If the links.next key exists, use it to create a request to get the next page. Continue to do so until you receive a JSON without a links.next key.
- Programatically implement limit and offset parameters in conjunction with the total_items key.
Pagination links JSON example
- The example that follows contains the result of the first request, consisting of the second two records in the data section (not displayed).
- The total number of records to return is 6.
- The links.next key contains the request that returns the next page—records 5 and 6.
{
"data": {[...]},
"meta": {
"total_items": 6
},
"links": {
"prev": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=0&limit=2",
"self": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=2&limit=2",
"next": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=4&limit=2"
}
}|
Query parameter |
Description |
|---|---|
| limit |
Number of records that return per call
|
| offset |
The first record to return in the call. Record numbers start with 0.
|
JSON response
|
Key |
Description |
|---|---|
| id |
App ID, for example: |
|
type |
Always return app |
|
name |
App name |
|
platform |
iOS or Android |
|
currency |
App-specific currency code as set by the advertiser |
|
time_zone |
App-specific timezone as set by the advertiser |
|
total_items |
Number of apps to which the ad network has the requested capabilities option |
|
links |
Pagination mechanism (explained in the parameters section)
|
Get app list curl example and response
Curl request
This example includes a complete call, including optional pagination parameters.
curl --location --request GET 'https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&limit=1000&offset=0' \
-H 'Authorization: Bearer {API V2.0 token available to the admin in the dashboard.}' \JSON response
{
"data": [
{
"id": "com.appsflyer.xpend_qa1",
"type": "app",
"attributes": {
"name": "com.appsflyer.xpend_qa1",
"platform": "android",
"currency": "USD",
"time_zone": "UTC"
}
},
{
"id": "com.abc.app",
"type": "app",
"attributes": {
"name": "com.abc.app",
"platform": "android",
"currency": "USD",
"time_zone": "UTC",
"enable_retargetting": true
}
},
{
"id": "com.xyz.app",
"type": "app",
"attributes": {
"name": "com.xyz.app",
"platform": "android",
"currency": "JPY",
"time_zone": "UTC"
}
}
],
"meta": {
"total_items": 3
},
"links": {
"self": "https://hq1.appsflyer.com/api/mng/apps?capabilities=protect_360&offset=0&limit=1000"
}
}HTTP response codes
|
Code |
Message |
Remarks/troubleshooting |
|---|---|---|
| 200 | OK |
Valid data returned |
| 200 | OK |
Symptom: No data returns Action: Make sure the authentication token is in the bearer header. |
| 400 | Bad request |
|
| 401 | Unauthorized |
Message: Authorization token is malformed Make sure you have the correct token; token must have 700+ characters. |
| 404 | Not found |
|
| 429 | Too many requests |
Exceeded rate limitation |
Comments
0 comments
Article is closed for comments.