POST

Count Reviews


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the number of reviews that match a specified filter.

If a filter isn't passed in the request, the method returns the count of all reviews.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Challenges
Access Verticals by Automations
Set Up Automations
Manage Reviews
Read reviews
Manage Events
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/reviews/v1/reviews/count

Body Params
filterstruct

Filter object in the following format: "filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }

For field support for filters and sorting, see Reviews: Supported Filters and Sorting.


includePrivateReviewsboolean

Whether to include unpublished reviews in the count.

Default: false

Response Object
countinteger

Number of reviews.

Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?