About the Reviews API

With the Reviews API you can manage reviews for a site's services, content, or products. The review object holds the content of the review, a rating score, images or video media, and information about the author. Learn more about Wix Reviews.

The Wix Reviews API allows your app to:

• Import reviews from other sites and export reviews to other sites.
• Retrieve and display positive review data. Use the Media API to retrieve associated review media.
• Retrieve negative review data enabling site owners to respond effectively.

The Reviews API can be used in conjunction with the Ratings API to provide broader rating functionality. For example, the Ratings API enables rating of multiple attributes of a product such as comfort and value for money.

Moderation

If moderation is turned on, reviews are checked for content that requires moderation. If moderation is required, the review remains pending until the site owner rejects or approves it in the site's Dashboard. The site owner can configure moderation settings in the site's Dashboard. Learn more about managing reviews.

Before you begin

It’s important to note the following points before starting to code:

• Every review needs a contact. To check whether a contact exists, your app can call the Contacts API with the author's email. If the author is already listed as a contact, use either Create Review or Create Review and Contact. If the author is not yet a site contact, use Create Review and Contact.
• A review author is limited to one review per entity. Duplicate reviews receive an error response.
• Replying to a review is available only in the site owner's Dashboard.

Use Cases

• Real-time 2-way sync with an eCommerce solution.
• Display review media in a widget.
• Get immediate updates of negative customer feedback.
• Display the most helpful product reviews in a widget.

Terminology

• Entity: The entity to review. For example, a Wix Stores product.
• Namespace: The Wix module that the Reviews API is integrated with. Currently only Wix Stores.
• Rating: The rating score for the review item. An author can give a rating score between 1 and 5. The rating is displayed with the site review.
• Helpfulness: Helpfulness is the overall helpfulness score calculated by subtracting Found Unhelpful from Found Helpful. Site visitors can indicate whether a review was helpful or not.
• Reply: A direct reply to a review that was left on the site. The reply is displayed with the review.

Reviews: Sample Use Cases and Flows

This article shares some possible use cases your app can support. You are not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.

Real-time 2-way sync with an eCommerce solution

Site owners can use your app to keep reviews from an eCommerce solution up to date with their reviews on Wix with a two-way sync. To synchronize Wix and the eCommerce solution, think about how your app will handle these flows:

• Initial setup
• Synchronize to the eCommerce solution
• Synchronize to Wix

Initial setup

Create mappings for the following from the Wix site to the eCommerce solution using common fields so the reviews can be synced:

• Wix site entities to entities in the eCommerce solution.
• Wix site Contact IDs to author IDs in the eCommerce solution, for example using email addresses.
• Wix review fields to the review fields in the eCommerce solution for example, title, body, author.

Store the mappings on your app's server. Then follow these flows to create the two-way sync.

Synchronize to the eCommerce solution

Listen for a change in Wix reviews with the following webhooks:

• Review Created Webhook.
• Review Updated Webhook.
• Review Deleted Webhook.

When one of the webhooks is triggered, you'll receive the review in the payload. You can send those changes to the eCommerce solution with a flow like this one:

1. Get the slug (which tells you what the event was), entityId (ID of the review), and other relevant information from the payload data.

2. Use the mappings from the initial setup to send the relevant information to the eCommerce solution.

3. Ignore the resulting event from the eCommerce solution so you don’t create an endless loop of updates.

Synchronize to Wix

Listen for review events from the eCommerce solution. When your app receives a change it needs to synchronize, follow this basic flow:

1. Use the Contacts API to check if the review author has a contact ID on the Wix site.

2. The Reviews API allows only one review for each entity per contact. Use the mappings from the initial setup to filter out imported reviews if there is already a Wix site review from the contact for the entity.

3. Use the mappings from the initial setup and call Create Review if the author is a contact. If the author is not a contact, call Create Review And Contact.

4. Ignore the resulting event from Wix so you don’t create an endless loop of updates.

Display review media in a widget

To enable a site owner to create a media gallery of photos from reviews, retrieve images from reviews and then display them in media layout.

1. Use Query Reviews to retrieve reviews that have media.

2. Extract the image.url from the response and use the Media API to retrieve the media.

3. Display the retrieved media items in gallery layout in a widget using Wix Blocks. Learn more about Wix Blocks apps.

Get immediate updates of negative customer feedback

To enable a site owner to receive timely customer feedback, gain insights into product satisfaction, and identify areas for improvement, follow this basic flow.

1. Listen for new reviews using the Review Created Webhook.

2. Get the entityId (ID of the review), content, and any other relevant information from the payload data.

3. Extract reviews from the payload that have content.rating less than 3.

4. Provide the extracted review IDs to the site owner so they can reply in the Dashboard.

Display the most helpful product reviews in a widget

To enable a site owner to display the most helpful reviews in order to promote products, follow this basic flow.

1. Use Query Reviews to get a list of the 10 most helpful reviews, sorted by most to least helpful.

2. Display the retrieved reviews in a widget using Wix Blocks. Learn more about Wix Blocks apps.

Reviews: Supported Filters and Sorting

The following table shows field support for filters and sorting for review properties:

Fields	Supported Filters	Sortable
id	$eq, $ne, $in
namespace	$eq, $ne, $in
entityId	$eq, $ne, $in
content.rating	$eq, $ne, $in, $lt, $lte, $gt, $gte	Sortable
content.media	$isEmpty
helpfulness	$eq, $ne, $in, $lt, $lte, $gt, $gte	Sortable
moderation.moderationStatus	$eq, $ne, $in
createdDate	$eq, $ne, $in, $lt, $lte, $gt, $gte	Sortable