{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/api/catalog/activities/relevance/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#relevance\" aria-label=\"relevance 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=\"relevance\"></div>Relevance</h1>\n<p><em>Relevance</em> is how most activities are sorted by default. Most activities will start with a value of <code class=\"language-text\">1</code> by default. Different values are calculated based on a variety of factors in order to offer activities that are more relevant to customers' interests.</p>\n<h2 style=\"position:relative;\"><a href=\"#types-of-relevance\" aria-label=\"types of relevance 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=\"types-of-relevance\"></div>Types of relevance</h2>\n<p>There are multiple relevance properties. Each one is recommended for different situations.</p>\n<h3 style=\"position:relative;\"><a href=\"#relevance-1\" aria-label=\"relevance 1 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=\"relevance-1\"></div><code class=\"language-text\">relevance</code></h3>\n<p>This is the default order to use when displaying activities.</p>\n<h3 style=\"position:relative;\"><a href=\"#relevance-category\" aria-label=\"relevance category 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=\"relevance-category\"></div><code class=\"language-text\">relevance-category</code></h3>\n<p>This is the recommended order to follow when displaying activities for a single category.</p>\n<h3 style=\"position:relative;\"><a href=\"#relevance-city\" aria-label=\"relevance city 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=\"relevance-city\"></div><code class=\"language-text\">relevance-city</code></h3>\n<p>This is the recommended order to follow when displaying activities for a single city.</p>\n<h3 style=\"position:relative;\"><a href=\"#relevance-venue\" aria-label=\"relevance venue 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=\"relevance-venue\"></div><code class=\"language-text\">relevance-venue</code></h3>\n<p>This is the recommended order to follow when displaying activities for a single venue.</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>To sort results by a specific relevance property, use the <code class=\"language-text\">sort_by</code> query parameter:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"21351713932864393000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`curl -X GET '{baseUrl}/activities?sort_by={relevanceType}' \\\\\n-H 'X-Musement-Application: {applicationValue}' \\\\\n-H 'X-Musement-Version: 3.4.0' \\\\\n-H 'Authorization: Bearer {accessToken}'`, `21351713932864393000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-21351713932864393000\">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={relevanceType}'</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>\n<p>By default, activities are sorted from lowest to highest relevance. If you want to sort from highest to lowest instead, add a <em>dash</em> in front of the relevance type value:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"57186018605979830000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`curl -X GET '{baseUrl}/activities?sort_by=-{relevanceType}' \\\\\n-H 'X-Musement-Application: {applicationValue}' \\\\\n-H 'X-Musement-Version: 3.4.0' \\\\\n-H 'Authorization: Bearer {accessToken}'`, `57186018605979830000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-57186018605979830000\">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=-{relevanceType}'</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":"Relevance","depth":1},{"value":"Types of relevance","depth":2},{"value":"<code class=\"language-text\">relevance</code>","depth":3},{"value":"<code class=\"language-text\">relevance-category</code>","depth":3},{"value":"<code class=\"language-text\">relevance-city</code>","depth":3},{"value":"<code class=\"language-text\">relevance-venue</code>","depth":3},{"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":"775c8e12-8431-56a2-9269-9a3e7023db96__redocly content/api/catalog/activities/relevance/","seo":{"title":"Relevance","description":"Activities in the Musement API are sorted by their relevance value by default.","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api/catalog/activities/relevance.md","pageBaseUrl":"/api/catalog/activities/relevance","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Relevance","id":"relevance"},{"depth":2,"value":"Types of relevance","id":"types-of-relevance"},{"depth":3,"value":"<code class=\"language-text\">relevance</code>","id":"relevance-1"},{"depth":3,"value":"<code class=\"language-text\">relevance-category</code>","id":"relevance-category"},{"depth":3,"value":"<code class=\"language-text\">relevance-city</code>","id":"relevance-city"},{"depth":3,"value":"<code class=\"language-text\">relevance-venue</code>","id":"relevance-venue"},{"depth":2,"value":"Sorting","id":"sorting"}]},"data":{"title":"","redirectFrom":["/guide/activities/relevance/","/api/partner/catalog/activities/relevance/"],"seo":{"description":"Activities in the Musement API are sorted by their relevance value by default."}},"catalogInfo":null,"link":"/api/catalog/activities/relevance/","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"]}