ASO App Keyword Ranking API for App Store
ASO App Keyword Ranking API for App Store. This API enables you to get keyword ranking
for the specific app.
Definition
Endpoint:
GET
https://data.42matters.com/api/v2.0/ios/aso/app_keyword_ranking.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 |
|
keywords |
required |
Comma-separated list of keywords to return rankings for. |
String. Example: keyword1,keyword2. Maximum 10 per request. |
|
start_date |
optional |
The start date of the rankings |
A valid date in the format yyyy-MM-dd, for example: 2022-03-22. Can't be earlier than last 30 days. |
30 days ago |
end_date |
optional |
The end date of the rankings. |
A valid date in the format yyyy-MM-dd, for example: 2022-04-21 |
Today |
days |
optional |
Set the date range from yesterday to the specified number of days in the past. |
Integer. Maximum 30 days. |
30 |
country |
optional |
Return country-specific apps |
ID of Supported Countries |
US |
lang |
optional |
Return language-specific apps |
ID of Supported Languages |
en |
limit |
optional |
How many keywords to return |
Integer. Maximum 50 per page. |
10 |
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. |
|
sort_order |
optional |
Ordering by date |
desc or asc |
asc |
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 |
trackId |
String |
The app trackId (unique identifier) |
keywords |
Array |
Array of keywords searched for |
country |
String |
Country search for |
lang |
String |
Language search for |
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 |
number_results |
Integer |
Number of results found |
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 |
results |
Array of Objects |
Each object contains array of dates:
date - A date in the format: yyyy-MM-dd
positions - Array of Objects:
keyword - String, position - Integer or null if not found
|
|
404 |
The keywords are 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: 14 Jul 2022