Relevance

Relevance is how most activities are sorted by default. Most activities will start with a value of 1 by default. Different values are calculated based on a variety of factors in order to offer activities that are more relevant to customers' interests.

Types of relevance

There are multiple relevance properties. Each one is recommended for different situations.

`relevance`

This is the default order to use when displaying activities.

`relevance-category`

This is the recommended order to follow when displaying activities for a single category.

`relevance-city`

This is the recommended order to follow when displaying activities for a single city.

`relevance-venue`

This is the recommended order to follow when displaying activities for a single venue.

Sorting

To sort results by a specific relevance property, use the sort_by query parameter:

Copy

Copied

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

By default, activities are sorted from lowest to highest relevance. If you want to sort from highest to lowest instead, add a dash in front of the relevance type value:

Copy

Copied

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