access_token |
required |
Your access token for using this API. You can get it for FREE by
signing up
.
|
|
|
id |
required |
The app ID on the Apple App Store - (e.g for Facebook the ID is 284882215).
|
Existing App ID on Apple App Store |
|
country |
optional |
ISO code of the country. If no country is specified, results of top 5 countries will be returned.
It is possible to query downloads for individual countries in one request by using
comma-separated countries
like US,DE,FR or ALL for all countries.
To return countries that have the most downloads use TOP - top country,
TOP_5 - top 5 countries,
TOP_10 - top 10 countries, TOP_20 - top 20 countries.
|
List of Supported Countries.
|
TOP_5 |
aggr |
optional |
Results will be aggregated based on your selection. Leaving aggr empty will return all results with
country code. Available options for aggr are:
daily - results aggregated daily.
weekly - results aggregated weekly.
monthly - results aggregated monthly.
region - results will be aggregated by supported regions based on the countries requested.
Supported regions: Europe, Asia, East Asia, Central Asia, South Asia, Southeast Asia, Western Asia, North America, Oceania, South America, Africa. |
daily, weekly, monthly, region. |
|
start_date |
optional |
The start date of the report |
A valid date in the format yyyy-MM-dd, for example: 2020-05-24 |
|
end_date |
optional |
The end date of the report. |
A valid date in the format yyyy-MM-dd, for example: 2020-05-30 |
|
days |
optional |
Set the date range from yesterday to the specified number of days in the past. |
Without Historical
Package: Last 30 days.
With Historical
Package: up to 2 years |
30 |
sort_order |
optional |
Ordering by date |
desc or asc |
asc |
device_type |
optional |
Supported device types. If device_type is empty or equals to any then all device types are returned. |
Value |
Information |
iphone |
iPhone devices |
ipad |
iPad devices |
any |
All devices |
|
limit |
optional |
Number of ranks to return. |
1-100 |
100 |
page |
optional |
Page based on the limit parameter, used for pagination. |
1 - max pages. There is a limit of 10000 results that can be iterated. |
1 |
callback |
optional |
If supplied, the response will use the JSONP format with a callback of the given
name.
|
|
|