Summarize App Reviews API
Recensia
500 atoms
AI tier
About
This API allows you to retrieve app reviews from the Apple App Store and Google Play Store.
This API is designed to provide developers and product teams with easy access to user feedback, enabling them to analyze trends, improve app performance, and address user concerns efficiently.
API Playground
API Documentation
Get Reviews
POST
https://api.apyhub.com/recensia/analyse_reviews
Request example
Method:
POST
Content Type:
application/json
Request Body
Attribute | M | Description | Accepted Values / Format |
---|---|---|---|
platform | Yes | The platform from which to retrieve reviews. | app_store , google_play |
app_id | Yes | The unique identifier of the app on the specified platform. | String |
country | Required if platform is app_store | The country code (ISO 3166-1 alpha-2) for filtering reviews from a specific region. | Example: US (for the United States) |
language | Required if platform is google_play | The language code (ISO 639-1) for filtering reviews by language. | Example: en (for English) |
start_date | No | The start date to filter reviews. | Format: YYYY-MM-DD |
end_date | No | The end date to filter reviews. | Format: YYYY-MM-DD |
sort_by | Yes | The parameter by which to sort the reviews. | For app_store : mostrecent , mosthelpful , mostfavorable , mostcritical For google_play : mostrelevant , newest , rating |
Sample Response
A successful request returns the extracted data from document as response in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.
HTTP Response Codes
The method may return one of the following HTTP status codes:
HTTP Status Code | Description | Example |
---|---|---|
200 OK | Request was successful. | N/A |
400 Bad Request | Returned if one or more required parameters are missing or invalid. | {"country": "This field is required for app_store platform."} {"language": "This field is required for google_play platform."} |
500 Internal Server Error | Returned if an internal issue occurs while processing the request. | N/A |
Authentication
All API requests to ApyHub services need to be authenticated. Currently we support
tokens
or basic authentication
mechanisms.
You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-token
as the header parameter to pass the token. - Use the
Authorization
header to send the basic authentication credentials.
Error codes
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents