Ratings

GET 2 Credits / Request / 30 days /android/applications/{APPLICATION_ID}/ratings-history.json

Ratings allows you to fetch the evolution of the star-rating of an app over time

Please note that the most recent rating of an app can be found in the metadata request. This request is intended to perform calculations on the evolution of this rating over time.

Ratings Request

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
country: string us

The two letter country code (ISO Alpha-2) you want to fetch the app in.

us. Get the list of our country codes, here.

start_date: date

Start date, format: YYYY-MM-DD

end_date: date

End date, format: YYYY-MM-DD

GET /android/applications/{APPLICATION_ID}/ratings-history.json

Request example
GET /android/applications/com.king.candycrushsaga/ratings-history.json?start_date=2021-11-20&end_date=2021-11-24&country=us
cURL example
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" "https://api.apptweak.com/android/applications/com.king.candycrushsaga/ratings-history.json?start_date=2021-11-20&end_date=2021-11-24&country=us"

Ratings Response

The response to the application ratings history request is a hash specifying the start and end date of the selected time period and an array containing one entry per day in the period.

The first object of the array correspond to the start_date, the second to the day following the start_date and so on. The last object corresponds to the end_date.

Object properties
start_date: string

The detected start date of the period.

end_date: string

The detected end date of the period.

ratings: array

An ordered list of objects, Each objects contains the number of 1,2,3,4 and 5 stars votes, the total number of votes, and the average score of the app.

Response Example

{
  "content": {
    "end_date": "2021-11-24 00:00:00 +0000",
    "ratings": [
      {
        "1": 674702,
        "2": 317645,
        "3": 1478963,
        "4": 5337183,
        "5": 24782198,
        "avg": 4.633,
        "total": 32590691
      },
      {
        "1": 675269,
        "2": 317698,
        "3": 1479208,
        "4": 5337972,
        "5": 24787387,
        "avg": 4.633,
        "total": 32597534
      },
      {
        "1": 675295,
        "2": 317893,
        "3": 1479877,
        "4": 5339382,
        "5": 24792937,
        "avg": 4.633,
        "total": 32605384
      },
      {
        "1": 675701,
        "2": 317838,
        "3": 1480114,
        "4": 5341331,
        "5": 24796401,
        "avg": 4.633,
        "total": 32611385
      },
      {
        "1": 676100,
        "2": 318286,
        "3": 1480950,
        "4": 5341009,
        "5": 24801566,
        "avg": 4.633,
        "total": 32617911
      }
    ],
    "start_date": "2021-11-20 00:00:00 +0000"
  },
  "metadata": {
    "content": {
    },
    "request": {
      "params": {
        "country": "us",
        "end_date": "2021-11-24T00:00:00+00:00",
        "format": "json",
        "id": "com.king.candycrushsaga",
        "start_date": "2021-11-20T00:00:00+00:00"
      },
      "path": "/applications/com.king.candycrushsaga/ratings-history.json",
      "performed_at": "2021-11-25 13:37:33 UTC",
      "store": "android"
    }
  }
}