Sign in

v1

latestOpenAPI 3.1.02026-07-24450694.7 KB

App Reviews Displayed

Get the top displayed reviews entries about a specific app on the App Store or Google Play in the selected country and based on the given sort parameter.

get/apps/reviews/top-displayed.json

Query parameters

appsstring required

Comma separated list of app IDs. Max 5 apps are allowed. <br/> <a href="https://developers.apptweak.com/reference/how-to-find-app-ids" target="_blank">How to find App IDs?</a>

sort'most_useful' | 'most_recent' | 'most_critical' | 'most_positive' required

The criteria by which reviews are sorted (most useful, most recent, most critical [<strong>only for IOS</strong>], most positive)

countrystring

Two letter <a href="https://apptweak.readme.io/reference/country-codes">country code</a>. <br/><b>Default:</b> us

languagestring

Two letter <a href="https://developers.apptweak.com/reference/country-codes#languages">language code</a>. <br/><b>Default:</b> us

device'iphone' | 'ipad' | 'android'

Choose a device from iphone, ipad or android. <br/><b>Default:</b> iphone

limitinteger

Number of reviews you want to fetch. <b>Max limit is 500</b> <br/><b>Default:</b> 100

offsetinteger

Index offset you want to apply to the reviews. <br/><b>Default:</b> 0

Response

200

OR

Example response

{
  "result": {
    "284910350": {
      "reviews": [
        {
          "date": "2019-08-16T14:12:18Z",
          "rating": 4,
          "title": "Very helpful",
          "body": "This would be my go-to to find anything. It’s really valuable to me. One thing I’d like to suggest is an option to update personal information. It’s very frustrating that I can’t and I suspect that this impacts how the app helps me. Thanks for your considering changing this.",
          "body_length": 275,
          "vote_count": 395,
          "vote_sum": 214,
          "id": "4625164510",
          "author": {
            "name": "anon6847",
            "type": "Customers",
            "id": 372307641
          }
        }
      ]
    }
  },
  "metadata": {
    "request": {
      "path": "/api/public/store/apps/reviews/top-displayed.json",
      "params": {
        "device": "iphone",
        "country": "gb",
        "limit": 10,
        "start_date": "2022-05-08",
        "end_date": "2022-06-06",
        "apps": [
          "284910350"
        ],
        "sort": "most_useful"
      },
      "cost": 11,
      "max_credit_cost": 11,
      "status": 200
    }
  }
}