app

Get app store reviews

Returns the customer reviews Runway currently holds for an app, newest first, across every store the app ships to (Apple App Store via App Store Connect, Google Play, Amazon Appstore, Huawei AppGallery, Samsung Galaxy Store). Each review carries the destination it came from, so reviews from different stores can be told apart.

These are reviews left by end users in the app stores — not Apple's or Google's review of a submitted build.

Runway holds the most recent window of reviews returned by each store rather than a full historical archive, so a caller building its own archive should poll often enough that the window always covers the gap since its last poll. submittedAfter and submittedBefore are both inclusive: a review submitted exactly at the boundary is returned. Reviews are uniquely identified by id — dedupe on it when polling incrementally.

get/app/{appId}/reviews

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/reviews
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

Query parameters

limitinteger

Maximum number of reviews to return.

offsetinteger

Number of reviews to skip, for paging through totalCount.

submittedAfterstring date-time

Only return reviews submitted at or after this RFC3339 timestamp (inclusive).

submittedBeforestring date-time

Only return reviews submitted at or before this RFC3339 timestamp (inclusive).

stepConfigIdstring

Only return reviews from this store destination. Use the destination.stepConfigId value from a previous response.

versionstring

Only return reviews left on this app version.

Response

A page of app store customer reviews for an app, newest first

totalCountinteger required

Number of reviews matching the request's filters, before pagination.

hasMoreboolean required

Whether more reviews remain beyond this page.

lastUpdatedAtstring date-time

When Runway last refreshed reviews from the app stores.

Example response

{
  "reviews": [
    {
      "rating": "4",
      "destination": {
        "name": "iOS App Store"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.