App list API for ad networks

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} 

Get app list mandatory parameters

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 request containing 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"
    }
}

Pagination mechanism parameters (optional)

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"
           }
}