Top Displayed Reviews

GET 5 Credits / Request /android/applications/{APPLICATION_ID}/reviews/displayed/{SORT}.json

Top Displayed Reviews allows you to fetch all the top displayed reviews entries about a specific app on the App Store in the selected country and based on the given sort parameter. Google classes by default the application's reviews by the Most Useful. With that endpoint you would be able to get the top displayed reviews for an application, based on that criterion.

Please note that the example has been stripped of redundant data to keep the documentation as concise as possible. The API might return additional, undocumented fields in the JSON, which your App should not rely upon.

Top Displayed Reviews Request

The Review list contains a series of review entries describing comments made by users on the app in the selected country. We limit the number of reviews returned by the API to the first 100 items by default, but you can specify the size by yourself (see below for more details).

By default, these results are sorted by the following criterion: Most Helpful, in the same way, as Google does in its Store.

Header parameters
X-AppTweak-Key:
Your AppTweak API Key.
Path parameters
APPLICATION_ID:
Application ID for which you want to get the metadata.
SORT:
Sort parameter allowing to display the data in the same order as Google does in its store. Available options: most_useful, most_recent, most_critical and most_positive.
Query parameters
language: string en

The two letter language (ISO Alpha-2) you want to fetch the application in.

en. Get the list of our language codes, here.

size: number 100

The number of reviews you want to fetch

GET /android/applications/{APPLICATION_ID}/reviews/displayed/{SORT}.json

Request example
GET /android/applications/com.facebook.katana/reviews/displayed/most_useful.json?language=us&size=100
cURL example
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" https://api.apptweak.com/android/applications/com.facebook.katana/reviews/displayed/most_useful.json?language=us&size=100

Top Displayed Reviews Response

The response to the Top displayed reviews request is a JSON hash containing all the existing review entries for the given application in the selected country on the Google Play Store and based on the given sort parameter.

Object properties
application_id: number

The ID that Google has given to the application.

author: hash

Key/value pairs containing the informations related to the author of the review (name, type and id).

CHILD PROPERTIES

name: string

Author's name.

photo: string

URL for the Author's profile picture

profile: string

Author's profile on the Google Play Store.

body: string

The "body" of the review, its main content.

body_length: number

The number of characters used in the body of the review.

date: datetime

The date on which the review has been posted on the Google Play Store for the related application.

id: number

The ID that Google has given to the review.

rating: number

The number of stars the user gave to the application (Integer 1 => 5).

sort_score: hash

Key/value pairs describing the score of this review depending on the type of sort (most_useful, most_recent, most_critical and most_positive).

title: string

The review title.

Response Example

{
  "content": [
    {
      "language": "us",
      "application_id": "com.facebook.katana",
      "version": "199.0.0.35.98",
      "date": "2018-11-18T09:10:03Z",
      "rating": 3,
      "title": "",
      "body": "BASAVARAJ",
      "body_length": 9,
      "id": "gp:AOqpTOE_CrMspau7uAx5QEjpugKiCsGObo5vhyotuc4YJIg6gPQPorzUz9TTSAKFrAAicWoHXBMRfocDzcO7Tg",
      "author": {
        "name": "A Google user",
        "photo": "https://lh4.googleusercontent.com/-3wpcE0uQ5Uw/AAAAAAAAAAI/AAAAAAAAAAA/5Xx1MzBdF24/photo.jpg",
        "profile": ""
      },
      "sort_score": {
        "most_useful": 1542905230
      }
    },
    {
      "language": "us",
      "application_id": "com.facebook.katana",
      "version": "199.0.0.35.98",
      "date": "2018-11-19T06:23:26Z",
      "rating": 5,
      "title": "",
      "body": "Assalamualaikum",
      "body_length": 15,
      "id": "gp:AOqpTOHAWqhUaLYyv0Y3b8TnmElJ-A5bT0i91xqw2mNpssjV3zoziHKqNITR7YMp0xTpIfzcbMY_V587blQB5g",
      "author": {
        "name": "Lateef Ahmad",
        "photo": "https://lh4.googleusercontent.com/-q5h7c6tzlXI/AAAAAAAAAAI/AAAAAAAAIYI/qocd3tT4iCQ/photo.jpg",
        "profile": "https://plus.google.com/107946227624939861333"
      },
      "sort_score": {
        "most_useful": 1542754836
      }
    }
  ],
  "metadata": {
    "request": {
      "path": "/applications/com.facebook.katana/reviews/displayed/most_useful.json",
      "store": "android",
      "params": {
        "language": "us",
        "size": 2,
        "id": "com.facebook.katana",
        "sort": "most_useful",
        "format": "json"
      },
      "performed_at": "2018-11-27 00:19:33 UTC"
    },
    "content": {
    }
  }
}