"Reviews" Collection Fields

To use the Reviews collection in code, refer to it as "Reviews/Reviews".

This document describes the permissions and fields in your Reviews collection.

Permissions

The Reviews collection has the following permissions:

• Read: Anyone
• Create: Admin
• Update: Admin
• Delete: Admin

You can't change the Reviews collection's permissions.

Fields

The field name is listed as the heading of each section, with the field ID listed in parentheses, like this: Name (name). The fields appear in this document in the order in which they appear in your collection by default.

Namespace (namespace)

Description: The app you're reviewing. For example, Wix Stores.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: eq, ne

Read-write: Yes

Required: Yes

Entity ID (entityId) (#)

Description: ID of the entity being reviewed. For example, a Wix Stores product.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-write: Yes

Required: Yes

ID (_id)

Description: Review ID.

Type: Text

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: eq, ne

Read-only: Yes

Required: No

Content (content)

Description: Review content.

Type: Object

Can connect to data: Yes, by content title, body, and rating.

Can use in dynamic page URL: No

Can be sorted: Yes, by Rating.

Can be filtered: Yes, only by rating - eq, ne, lt, let, gt, gte

Read-write: Yes, only Rating.

Required: No

Created Date (_createdDate)

Description: Date and time the review was created.

Type: Date and time

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: Yes

Can be filtered: eq, ne, lt, lte, gt, gte

Read-only: Yes

Required: No

Updated Date (_updatedDate)

Description: Date and time the review was last updated.

Type: Date and time

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: No

Author (author)

Description: A JSON object that describes the author of the review.

Type: Object

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: Yes

Reply (reply)

Description: A JSON object that describes the reply to the review.

Type: Text

Can connect to data: Yes, by the reply's message.

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: No

Found Helpful (foundHelpful)

Description: Number of people who found the review helpful.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: No

Found Unhelpful (foundUnhelpful)

Description: Number of people who found the review unhelpful.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: No

Helpfulness (helpfulness)

Description: Helpfulness score. Calculated by subtracting Found Unhelpful from Found Helpful.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: Yes

Can be sorted: Yes

Can be filtered: eq, ne, lt, lte, gt, gte

Read-only: Yes

Required: No

Moderation (moderation)

Description: A JSON object that describes the moderation status of the review.

Type: Object

Can connect to data: Yes, by the moderation's moderationStatus.

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: Yes, only by moderationStatus - eq, ne.

Read-only: Yes

Required: No

Note: moderationStatus is one of the following:

• APPROVED: The review is approved and published.
• IN_MODERATION: The review is pending moderation.
• REJECTED: The review is rejected and deleted from the site.
• SUBMITTED: Initial status of the review before the moderation process.

Revision (revision)

Description: Revision number, which increments by 1 each time the review is updated.

Type: Text

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: No

Verified (verified)

Description: Indicates if the review has been verified.

Type: Boolean

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: Yes

Can be filtered: eq, ne

Read-only: Yes

Required: No

Origin (origin)

Description: Provides information about the origin of the review. Organic reviews are created by site visitors or members. App reviews are created by apps even though a site visitor or member is the author of the review. Apps can't create or update organic reviews.

Type: Object

Can connect to data: No

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: Yes, only by type - eq, ne

Read-only: Yes

Required: No

Review Date (reviewDate)

Description: Date and time when the review was written. This should match the created date, except for reviews imported from another review system.

Type: Date and time

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: No

Relevance Score (relevanceScore)

Description: Relevance score calculated by reviews platform based on review content. Used to sort reviews by relevance to reviewed item.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: Yes

Can be sorted: Yes

Can be filtered: eq, ne, lt, lte, gt, gte, urlized

Read-only: Yes

Required: No

Publish Count (publishCount)

Description: Counts the number of times a review has been published. Reviews require approval before publishing, unless moderation is disabled. When moderation is disabled, reviews are automatically approved and published.

Type: Number

Can connect to data: Yes

Can use in dynamic page URL: No

Can be sorted: No

Can be filtered: No

Read-only: Yes

Required: No