Reviews Stats

GET 2 Credits / Request /ios/applications/{APPLICATION_ID}/reviews/filter/stats.json

Reviews Stats allows you to fetch all the stats related to the reviews entries about a specific app on the App 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.

Reviews Stats Request

This endpoint returns all the stats collected by AppTweak on all the reviews available on the selected period (dates range) for the given app in the chosen country.

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.

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

GET /ios/applications/{APPLICATION_ID}/reviews/filter/stats.json

Request example
GET /ios/applications/454638411/reviews/filter/stats.json?country=us&min_rating=1&max_rating=5&start_date=2018-09-01&end_date=2018-09-30&term=bug
cURL example
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" https://api.apptweak.com/ios/applications/454638411/reviews/filter/stats.json?country=us&min_rating=1&max_rating=5&start_date=2018-09-01&end_date=2018-09-30&term=bug

Reviews Stats Response

The Review stats is a JSON hash containing both aggregate stats for all reviews on the selected period (date range) but also on a daily basis.

Object properties
aggregate: hash

Aggregated stats for the selected period.

CHILD PROPERTIES

total: number

The number of reviews posted on the selected period which satisfies the given criteria.

average: number

Average rating for the reviews posted on the selected period which satisfies the given criteria.

count: hash

Key/value pair providing the number of reviews posted on the selected period which satisfies the given criteria, per rating (1 => 5).

daily: hash

Key/value pair providing the stats on a daily basis for all reviews posted on the selected period which satisfies the given criteria.

CHILD PROPERTIES

start_date: datetime

Start date for the selected period.

end_date: datetime

End date for the selected period.

stats: array

Array of hash containing the same information as the aggregate entry but on a daily basis.

Response Example

{
  "content": {
    "aggregate": {
      "total": 22,
      "average": 2.090909090909091,
      "count": {
        "1": 11,
        "2": 2,
        "3": 6,
        "4": 2,
        "5": 1
      }
    },
    "daily": {
      "start_date": "2018-09-01",
      "end_date": "2018-09-30",
      "stats": [
        {
          "total": 9,
          "average": 2.4444444444444446,
          "count": {
            "3": 4,
            "1": 3,
            "2": 1,
            "5": 1
          }
        },
        {
          "total": 1,
          "average": 1.0,
          "count": {
            "1": 1
          }
        },
        {
          "total": 1,
          "average": 1.0,
          "count": {
            "1": 1
          }
        }
      ]
    }
  },
  "metadata": {
    "request": {
      "path": "/applications/454638411/reviews/filter/stats.json",
      "store": "ios",
      "params": {
        "country": "us",
        "min_rating": 1,
        "max_rating": 5,
        "start_date": "2018-09-01T00:00:00+00:00",
        "end_date": "2018-09-30T00:00:00+00:00",
        "term": "bug",
        "id": "454638411",
        "format": "json"
      },
      "performed_at": "2018-11-20 14:19:09 UTC"
    },
    "content": {
    }
  }
}