queryReviews( )

Developer Preview

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

Creates a query to retrieve a list of reviews.

The queryReviews() function builds a query to retrieve a list of reviews and returns a ReviewsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining ReviewsQueryBuilder functions onto the query.

ReviewsQueryBuilder functions enable you to sort, filter, and control the results that queryReviews() returns.

The queryReviews() function runs with the following defaults, which you can override:

  • ascending("_createdDate")
  • limit(100)

The functions that are chained to queryReviews() are applied in the order they're called. For example, if you apply descending("_createdDate") and then descending("content.rating"), the results are sorted first by the _createdDate, and then, if there are multiple results with the same _createdDate, the items are sorted by content.rating.

PROPERTYSUPPORTED FILTERS & SORTING
namespaceeq(),ne(),in()
_ideq(),ne(),in()
content.ratingeq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
_createdDateeq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
helpfulnesseq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
moderation.moderationStatuseq(),ne(),in()
verifiedeq(),ne(),ascending(),descending()
origin.typeeq(),ne(),ascending(),descending()
relevanceScoreeq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
Permissions
Manage Bookings Services and Settings
Read reviews
Manage Reviews
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryReviewsOptions

Information about the reviews to retrieve.

Returns
Was this helpful?
Yes
No