{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/api/catalog/activities/ratings/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#ratings\" aria-label=\"ratings permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"ratings\"></div>Ratings</h1>\n<p>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).</p>\n<p>Details on the ratings are available for each activity in both the <code class=\"language-text\">/activities</code> and <code class=\"language-text\">/activities/{activityUuid}</code> endpoints. The following properties are related to activity ratings:</p>\n<ul>\n<li>\n<code class=\"language-text\">reviews_aggregated_info</code>\n<ul>\n<li>\nThis is the breakdown of the number of reviews for each rating value.\n</li>\n</ul>\n</li>\n<li>\n<code class=\"language-text\">reviews_avg</code>\n<ul>\n<li>\nThis is the mean average rating value.\n</li>\n</ul>\n</li>\n<li>\n<code class=\"language-text\">reviews_number</code>\n<ul>\n<li>\nThis displays the total number of reviews for the activity.\n</li>\n</ul>\n</li>\n</ul>\n<p>In the example response below, the activity has a rating of <code class=\"language-text\">4.3</code>, based on three reviews:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"25127728732488850000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`\t[...]\n\t&quot;reviews_number&quot;: 3,\n\t&quot;reviews_avg&quot;: 4.3,\n\t&quot;reviews_aggregated_info&quot;: {\n\t\t&quot;1&quot;: 0,\n\t\t&quot;2&quot;: 0,\n\t\t&quot;3&quot;: 0,\n\t\t&quot;4&quot;: 2,\n\t\t&quot;5&quot;: 1\n\t},\n\t[...]`, `25127728732488850000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-25127728732488850000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"json\"><pre class=\"language-json\"><code class=\"language-json\">\t<span class=\"token punctuation\">[</span>...<span class=\"token punctuation\">]</span>\n\t<span class=\"token property\">\"reviews_number\"</span><span class=\"token operator\">:</span> <span class=\"token number\">3</span><span class=\"token punctuation\">,</span>\n\t<span class=\"token property\">\"reviews_avg\"</span><span class=\"token operator\">:</span> <span class=\"token number\">4.3</span><span class=\"token punctuation\">,</span>\n\t<span class=\"token property\">\"reviews_aggregated_info\"</span><span class=\"token operator\">:</span> <span class=\"token punctuation\">{</span>\n\t\t<span class=\"token property\">\"1\"</span><span class=\"token operator\">:</span> <span class=\"token number\">0</span><span class=\"token punctuation\">,</span>\n\t\t<span class=\"token property\">\"2\"</span><span class=\"token operator\">:</span> <span class=\"token number\">0</span><span class=\"token punctuation\">,</span>\n\t\t<span class=\"token property\">\"3\"</span><span class=\"token operator\">:</span> <span class=\"token number\">0</span><span class=\"token punctuation\">,</span>\n\t\t<span class=\"token property\">\"4\"</span><span class=\"token operator\">:</span> <span class=\"token number\">2</span><span class=\"token punctuation\">,</span>\n\t\t<span class=\"token property\">\"5\"</span><span class=\"token operator\">:</span> <span class=\"token number\">1</span>\n\t<span class=\"token punctuation\">}</span><span class=\"token punctuation\">,</span>\n\t<span class=\"token punctuation\">[</span>...<span class=\"token punctuation\">]</span></code></pre></div>\n      </div>\n<p>You are encouraged to display the rating and relevant review information to help customers understand an activity's popularity.</p>\n<h2 style=\"position:relative;\"><a href=\"#sorting\" aria-label=\"sorting permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"sorting\"></div>Sorting</h2>\n<p>You sort results by their rating using the <code class=\"language-text\">sort_by</code> query parameter and the value <code class=\"language-text\">rating</code>:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"28805635869459170000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`curl -X GET '{baseUrl}/activities?sort_by=rating' \\\\\n-H 'X-Musement-Application: {applicationValue}' \\\\\n-H 'X-Musement-Version: 3.4.0' \\\\\n-H 'Authorization: Bearer {accessToken}'`, `28805635869459170000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-28805635869459170000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash\"><code class=\"language-bash\"><span class=\"token function\">curl</span> <span class=\"token parameter variable\">-X</span> GET <span class=\"token string\">'{baseUrl}/activities?sort_by=rating'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Application: {applicationValue}'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Version: 3.4.0'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'Authorization: Bearer {accessToken}'</span></code></pre></div>\n      </div>","headings":[{"value":"Ratings","depth":1},{"value":"Sorting","depth":2}]},"contentItem":{"data":{"lastModified":"2025-12-18T16:31:42.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"1d3b745a-ee88-5b65-8686-ba24cd4c5a16__redocly content/api/catalog/activities/ratings/","seo":{"title":"Ratings","description":"Activities contain multiple details about their customer ratings in the Musement API.","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api/catalog/activities/ratings.md","pageBaseUrl":"/api/catalog/activities/ratings","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Ratings","id":"ratings"},{"depth":2,"value":"Sorting","id":"sorting"}]},"data":{"title":"","redirectFrom":["/guide/activities/ratings/","/api/partner/catalog/activities/ratings/"],"seo":{"description":"Activities contain multiple details about their customer ratings in the Musement API."}},"catalogInfo":null,"link":"/api/catalog/activities/ratings/","sidebarName":"__alternative-sidebar__-data-24763-api-sidebars.yaml","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}