Ratings

After a customer's scheduled booking has passed, they are asked to submit a review where they can describe their experience and rate it from 1 (poor experience) to 5 (amazing experience).

Details on the ratings are available for each activity in both the /activities and /activities/{activityUuid} endpoints. The following properties are related to activity ratings:

• reviews_aggregated_info
  • This is the breakdown of the number of reviews for each rating value.
• reviews_avg
  • This is the mean average rating value.
• reviews_number
  • This displays the total number of reviews for the activity.

In the example response below, the activity has a rating of 4.3, based on three reviews:

	[...]
	"reviews_number": 3,
	"reviews_avg": 4.3,
	"reviews_aggregated_info": {
		"1": 0,
		"2": 0,
		"3": 0,
		"4": 2,
		"5": 1
	},
	[...]

You are encouraged to display the rating and relevant review information to help customers understand an activity's popularity.

Sorting

You sort results by their rating using the sort_by query parameter and the value rating:

curl -X GET '{baseUrl}/activities?sort_by=rating' \
-H 'X-Musement-Application: {applicationValue}' \
-H 'X-Musement-Version: 3.4.0' \
-H 'Authorization: Bearer {accessToken}'