Apple App Store Weekly App Ratings History API
Apple App Store Weekly App Ratings History API. Retrieve comprehensive historical app ratings
insights
for
any iOS app available on Apple App Store.
Definition
Endpoint:
GET
https://data.42matters.com/api/v2.0/ios/apps/ratings.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. |
List of Supported Countries |
US |
event_field |
optional |
Field type to filter for |
userRatingCount or averageUserRating. See iOS App Object for more
details about these fields. |
userRatingCount |
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 5 years |
1 |
sort_order |
optional |
Ordering by date |
desc or asc |
asc |
limit |
optional |
Number of results to return. |
1-100. Free trial results limited to 5. |
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. |
|
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 |
event_field |
String |
Field type |
min |
Double |
Minimum value for the period |
max |
Double |
Maximum value for the period |
avg |
Double |
Average from values for the period |
results |
Array of Objects |
Sorted list of objects in the response. Each rating object contains:
date,
value
|
|
404 |
The package name 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 |
Example Request
This request can also be imported into Postman.
Check out our Postman integration guide.
Example Response
{
"number_results": 8,
"num_pages": 1,
"has_next": false,
"limit": 100,
"page": 1,
"trackId": "835599320",
"start_date": "2023-04-29",
"end_date": "2023-05-28",
"dates": [
"2023-05-01",
"2023-05-02",
"2023-05-08",
"2023-05-09",
"2023-05-15",
"2023-05-16",
"2023-05-22",
"2023-05-23"
],
"event_field": "userRatingCount",
"min": 14612351,
"max": 14760016,
"avg": 14680396,
"results": [
{
"date": "2023-05-01",
"value": 14612351
},
{
"date": "2023-05-02",
"value": 14619294
},
{
"date": "2023-05-08",
"value": 14652630
},
{
"date": "2023-05-09",
"value": 14657968
},
{
"date": "2023-05-15",
"value": 14690494
},
{
"date": "2023-05-16",
"value": 14696384
},
{
"date": "2023-05-22",
"value": 14754028
},
{
"date": "2023-05-23",
"value": 14760016
}
]
}
Last Modified: 23 September 2021