APapptweak
App Reviews

App Reviews Search

Changed on

Get all 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. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Description</th><th>Credits/review</th></tr></thead> <tbody> <tr><td><b>review</b></td><td>review object containing the review body, review ID, author and more.</td><td>1</td></tr> </tbody> </table> <Callout icon="📘" theme="info"><b>Missing App Reviews?</b><p>Are you not seeing your app reviews? It's probably because the app is not followed and we haven't fetched data for it. You should make sure to track the app with our API (or follow it in our ASO tool) to ensure its data is fetched daily.</p></Callout>

get/apps/reviews/search.json

Request

  • Base URL
    https://public-api.apptweak.com/api/public/store
  • URL
    https://public-api.apptweak.com/api/public/store/apps/reviews/search.json
  • Auth
    API key in header x-apptweak-key

Query parameters

appsstring required

Comma-separated list of app IDs (max 5). <a href="https://developers.apptweak.com/reference/how-to-find-app-ids" target="_blank"><b>How to find App IDs?</b></a>

countrystring

Two-letter country code (us, gb, fr). Accepted values: <a href="https://developers.apptweak.com/reference/countries-1" target="_blank"><code>GET /api/public/apptweak/countries</code></a> with store=ios or store=android. Defaults to us.

languagestring

AppTweak language code, not always ISO: US English is us, US Spanish sp. Accepted pairs: <a href="https://developers.apptweak.com/reference/languages-1" target="_blank"><code>GET /api/public/apptweak/languages</code></a> with store=ios or store=android. Defaults to the country's <a href="https://developers.apptweak.com/reference/languages-overview#default-language" target="_blank"><b>default language</b></a>.

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

Choose a device from iphone, ipad or android. Defaults to iphone.

limitinteger

Number of reviews to fetch (max 500). Defaults to 100.

offsetinteger

Index offset to apply to the reviews. Defaults to 0.

replied'true' | 'false' | 'nil'

Keep only the reviews the developer replied to (true) or did not reply to (false). Omit it, or pass nil, for no filter.

termstring

Term to search for in the review body. Defaults to empty.

min_ratinginteger

Minimum rating to filter reviews by (1–5). Defaults to 1.

max_ratinginteger

Maximum rating to filter reviews by (1–5). Defaults to 5.

start_datestring date

Start date (YYYY-MM-DD). Defaults to 30 days ago.

end_datestring date

End date (YYYY-MM-DD). Defaults to yesterday.

Response

Successful response.

resultobject

Changes

  • a4af4000f1e3Revision changes
    • breaking

      for the query request parameter device, default value was changed from android to iphone

    • breaking

      for the query request parameter limit, default value was changed from 10 to 100

    • breaking

      for the query request parameter end_date, default value 2022-05-07 was removed

    • breaking

      for the query request parameter language, default value us was removed

    • breaking

      for the query request parameter start_date, default value 2022-05-01 was removed

    • breaking

      the response's body type changed from no type to object for status

    • info

      api tag App Reviews added

    • info

      added the new optional query request parameter max_rating

    • info

      added the new optional query request parameter min_rating

    • info

      removed subschema #1: iOS subschema #2: Android from the response body oneOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status