App Store iOS App Download Estimates History API
App Store iOS App Download Estimates History API. Retrieve comprehensive historical app download estimates insights for any Android app available on Apple App Store.
Definition
Endpoint:
GET
https://data.42matters.com/api/v4.0/ios/apps/download_estimates.json
Parameters
Name |
Required |
Description |
Available Values |
Default |
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, US will be used.
You can use multiple countries like US,DE,FR to get total downloads for those countries
or ALL for all countries.
To return country that has most downloads use TOP as a country code.
|
List of Supported Countries.
|
US |
aggr |
optional |
Results will be aggregated by this value. |
daily, weekly, monthly, region. |
daily |
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. |
1 |
callback |
optional |
If supplied, the response will use the JSONP format with a callback of the given
name.
|
|
|
Responses
Status Code |
Indication |
Content-Type |
Body |
200 |
Everything is OK |
application/json |
Attribute |
Type |
Description |
number_results |
Integer |
Total number of results for this query |
num_pages |
Integer |
Maximum number of pages it's possible to iterate |
has_next |
Boolean |
Flag indicating if there is a next page available |
limit |
Integer |
Number of results per request |
page |
Integer |
Current page number |
trackId |
String |
Numeric unique identifier for the app assigned by Apple |
start_date |
Date |
A date in the format: yyyy-MM-dd |
end_date |
Date |
A date in the format: yyyy-MM-dd |
dates |
Array of dates |
Sorted list of dates in the response |
countries |
Array of countries strings |
List of countries in the response |
regions |
Array of region objects |
List of region objects containing region name and code in the response. Is available only
when using aggregation region. |
total_downloads |
Integer |
Total number of downloads for selected country in requested period |
download_estimates |
Array of Objects |
Sorted list of download estimates objects in the response. Each download estimate contains:
array of dates.
Array of dates contains
date - date string or region - region code,
total - total number of downloads.
If a total is null, it means the app does not have data for this country on that date.
|
|
404 |
The trackId is not found |
application/json |
Error object |
402 |
Your request exceeds what's allowed by your current subscription plan |
application/json |
Error object |
403 |
Your access token is not valid |
application/json |
Error object |
429 |
Your request rate is over the limit |
application/json |
Error object |
Last Modified: 7 Oct 2021