A collection of endpoints which can be used to search the catalog for relevant activities.
API reference//
- Get review statistics for activity
Search reviews for activity
Add review to activity
Get review statistics for...
Musement API (3.5.0)
For merchant or affiliate partners wishing to use the Musement API.
See the Authentication section for details on how to authenticate with the API.
GET /activities/{activityUuid}/dates/{date}- Added
availability,max_buyandmin_buyproperties to timeslots. For more info, check out our guide
- Added
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://partner-api.musement.com/_mock/reference/openapi
Sandbox server
https://sandbox.musement.com/api/v3
Production server
https://api.musement.com/api/v3
Bodyapplication/jsonrequired
Can we publish this review? If true, the review might be included in reviews for the activity, pending an internal evaluation. When false, the review will never be part of reviews for the activity, but its rating will be added to the activity's review statistics.
Default false
Example: true
The language of the customer's written review, following RFC 3066.
Example: "en-GB"
The Musement order item UUID that the review is for.
Example: "d83d4e0a-e62b-4c81-b403-4206914cd697"
The identifier for the review from the service providing the review data.
Example: "R_wXE9FFQ1qhK2J0w"
The customer's name as it should be displayed with the review.
Example: "John Doe"
The customer's rating of their experience, based on the rating_scale.
Example: 4
The rating scale used for the review, from the lowest to the highest value: {lowest}..{highest}
Example: "1..5"
The customer's traveler type.
Enum"ALONE""AS-A-COUPLE""WITH-FAMILY""WITH-FRIENDS"
Example: "WITH-FAMILY"
The date and time the review was written.
Example: "2021-11-18T15:13:13"
- Mock serverhttps://partner-api.musement.com/_mock/reference/openapi/activities/{activityUuid}/reviews
- Sandbox serverhttps://sandbox.musement.com/api/v3/activities/{activityUuid}/reviews
- Production serverhttps://api.musement.com/api/v3/activities/{activityUuid}/reviews
- curl
- C#
- Node.js
curl -i -X POST \
'https://partner-api.musement.com/_mock/reference/openapi/activities/{activityUuid}/reviews' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"age": 27,
"comment": "Awesome experience.",
"date": "2021-11-18T15:13:13",
"is_public": true,
"locale": "en-GB",
"order_item_uuid": "d83d4e0a-e62b-4c81-b403-4206914cd697",
"provider": "QUALTRICS",
"provider_id": "R_wXE9FFQ1qhK2J0w",
"public_username": "John Doe",
"rating_categories": [
{
"category_code": "SERVICE",
"category_rating": 4,
"rating_scale": "1..5"
}
],
"rating_scale": "1..5",
"rating_value": 4,
"traveler_type": "WITH-FAMILY"
}'Headers
The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.
Default en-US
A partner's application value, used for analyzing API usage and to identify areas of improvement.
The API version to use for the request.
When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.
Example: 3.4.0
- Mock serverhttps://partner-api.musement.com/_mock/reference/openapi/activities/{activityUuid}/reviews/statistics
- Sandbox serverhttps://sandbox.musement.com/api/v3/activities/{activityUuid}/reviews/statistics
- Production serverhttps://api.musement.com/api/v3/activities/{activityUuid}/reviews/statistics
- curl
- C#
- Node.js
curl -i -X GET \
'https://partner-api.musement.com/_mock/reference/openapi/activities/{activityUuid}/reviews/statistics' \
-H 'Accept-Language: en-US' \
-H 'X-Musement-Application: string' \
-H 'X-Musement-Version: 3.4.0'Review statistics for activity
The overall rating of the reviews on a scale of zero (poor) to ten (amazing).
Example: 7.65
A breakdown of each rating by category.
Example: [{"category_code":"SERVICE","category_name":"Service","category_rating":7.5}]
The code for the review category.
Enum"SAFETY""SERVICE""STAFF""VALUE-FOR-MONEY"
Example: "SERVICE"
The name of the category, translated based on the Accept-Language header value.
Example: "Service"
A breakdown of the number of reviews per rating on the scale.
Example: [{"rating":1,"reviews_count":0},{"rating":2,"reviews_count":100},{"rating":3,"reviews_count":0},{"rating":4,"reviews_count":200},{"rating":5,"reviews_count":0},{"rating":6,"reviews_count":250},{"rating":7,"reviews_count":0},{"rating":8,"reviews_count":0},{"rating":9,"reviews_count":75},{"rating":10,"reviews_count":175}]
Response
application/json
{ "reviews_number": 700, "overall_rating": 7.65, "reviews_per_rating": [ { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … } ], "rating_categories": [ { … } ] }