Application Filtered Reviews

GET 5 Credits / Request /android/applications/{APPLICATION_ID}/reviews/filter/list.json

Application Filtered Reviews allows you to fetch all the reviews entries about a specific app on the Google Play Store in the selected country and based on several criteria like date, rating or even to search for a specific word or expression in the reviews's body.

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.

Application Filtered 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 without regard the period (dates range), but you can specify the size by yourself (see below for more details).

Header parameters
X-AppTweak-Key:
Your AppTweak API Key.
Path parameters
APPLICATION_ID:
Application ID for which you want to get the metadata.
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.

min_rating: number

Minimum rating value

Integer between 1 and 5

max_rating: number

Maximum rating value

Integer between 1 and 5

start_date: date

Start date, format: YYYY-MM-DD

end_date: date

End date, format: YYYY-MM-DD

term: string

Term to search for.

For instance: bug

from: number

Index from which we start to fetch the data (pagination)

size: number 100

The number of reviews you want to fetch

GET /android/applications/{APPLICATION_ID}/reviews/filter/list.json

Request example
GET /android/applications/com.king.candycrushsodasaga/reviews/filter/list.json?language=en&min_rating=3&max_rating=5&start_date=2018-11-01&end_date=2018-11-26&term=crush&size=10
cURL example
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" https://api.apptweak.com/android/applications/com.king.candycrushsodasaga/reviews/filter/list.json?language=en&min_rating=3&max_rating=5&start_date=2018-11-01&end_date=2018-11-26&term=crush&size=10

Application Filtered Reviews Response

The response to the filtered 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 query parameters.

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.king.candycrushsodasaga",
      "version": "1.127.3",
      "date": "2018-11-21T14:59:53Z",
      "rating": 2,
      "title": "",
      "body": "After 6 months stuck on the same level (772) I'm finally giving up and removing the game. I have a lot of other people saying the same about soda, it's just getting way too hard on the levels and it has turned to cause more frustration than fun. Hope they won't mess up the other ones like this one. Shame.",
      "body_length": 306,
      "id": "gp:AOqpTOF2ZrdQdzvXNg0vn_d9Fg1WWtrw9oQoY-Pn1i_vpjAQw4d5BgtXgTfWicHw0-j1dFjyK79s2TJc4cKiBw",
      "author": {
        "name": "Isabela Kornic",
        "photo": "https://lh3.googleusercontent.com/-jlcqwkZSY84/AAAAAAAAAAI/AAAAAAAAAAA/AGDgw-hnx_VAeJA_X_hF5MFq1VwX3xYirA/photo.jpg",
        "profile": "https://plus.google.com/114297050613958101177"
      },
      "sort_score": {
        "most_recent": 1542826121,
        "most_useful": 1543253468
      }
    }
  ],
  "metadata": {
    "request": {
      "path": "/applications/com.king.candycrushsodasaga/reviews/filter/list.json",
      "store": "android",
      "params": {
        "min_rating": 3,
        "max_rating": 5,
        "start_date": "2018-11-01T00:00:00+00:00",
        "end_date": "2018-11-26T00:00:00+00:00",
        "term": "soda",
        "size": 10,
        "country": "us",
        "id": "com.king.candycrushsodasaga",
        "format": "json"
      },
      "performed_at": "2018-11-27 00:41:53 UTC"
    },
    "content": {
    }
  }
}