Additional searches

A collection of additional endpoints which can be used to search parts of the catalog.

Search cities, lists and venues

This endpoint returns resources which are related to activities: cities, lists and/or venues.

Its query parameters are similar to those used in the /activities and /autocomplete endpoints, but it does not return activities.

Request
query Parameters
city_limit
integer >= 0

Limit the maximum number of cities to include in the response.

A positive value is required in order to receive cities in the response.

city_offset
integer >= 0
Default: 0

Exclude the first N cities from the response, where N is the specified integer value.

coordinates
string(-)?\d{1,3}(\.\d+)?,(-)?\d{1,3}(\.\d+)?

Filter results to those located near the specified latitude and longitude. Separate the coordinates with a comma.

Must be used together with the distance parameter.

Example: coordinates=45.7386,-9.3641
extend_content_fields
string
Default: AUTO

Combined with the text parameter, filter results based on the title only or all content properties:

  • AUTO: initially filter results based on titles. If no results are found, extend the search to include other content properties.
  • NO: filter results based on titles only.
  • YES: filter results based on all content properties.
Enum: AUTO NO YES
extend_other_languages
string
Default: AUTO

Combined with the text parameter, filter results based on the Accept-Language header value or all languages:

  • AUTO: initially filter results based on the Accept-Language header value. If no results are found, extend the search to include all languages.
  • NO: filter results based on the Accept-Language header value.
  • YES: filter results based on all languages.
Enum: AUTO YES NO
fuzziness_level
string
Default: LEVEL-0

Change the "fuzziness" level for the text parameter value. Higher levels are less strict about exact text matches.

Enum: AUTO LEVEL-0 LEVEL-1 LEVEL-2
list_limit
integer >= 0

Limit the maximum number of Musement lists to include in the response.

A positive value is required in order to receive lists in the response.

list_offset
integer >= 0
Default: 0

Exclude the first N Musement lists from the response, where N is the specified integer value.

minimum_events
integer >= 1
Default: 1

Filter results to those which are connected to the specified minimum number of activities.

sort_by
Array of strings

Sort results by one or more of the following values:

  • relevance: From lowest to highest relevance value.
  • -relevance: From highest to lowest relevance value.
  • distance: Results closest to the coordinates parameter appear first.
  • -distance: Results farthest from the coordinates parameter appear first.

This parameter will accept two values, separated with a comma.

Items which do not use relevance or coordinates will not be affected by this parameter.

Items Enum: distance -distance relevance -relevance
text
string

Filter results by key words.

text_operator
string
Default: AUTO

Change how the text parameter filters results when multiple words are used:

  • AND: results must contain all the key words.
  • AUTO: filters by AND first. If there are no results, extend to include OR results.
  • OR: results must contain at least one of the key words.
Enum: AND AUTO OR
venue_limit
integer [ 0 .. 5 ]

Limit the maximum number of venues to include in the response.

A positive value is required in order to receive venues in the response.

Using a value greater than the maximum is ignored and the maximum number of possible results is used instead.

venue_offset
integer >= 0
Default: 0

Exclude the first N venues from the response, where N is the specified integer value.

zero_terms_query
string
Default: NONE

If set to ALL, if all of the stop words have been removed, search will be performed, if set to 'NONE' will not

Enum: NONE ALL
header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Market
string (Musement market)
Default: us

Musement markets contain a modified catalog of activities and prices. Partners are expected to use their assigned market code to view their customized catalog.

An invalid X-Musement-Market value will return a 400 status code response.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

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
Responses
200

Search results

default

Error

get/activities-related
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/activities-related?city_limit=0&city_offset=0&coordinates=45.7386%2C-9.3641&extend_content_fields=AUTO&extend_other_languages=AUTO&fuzziness_level=AUTO&list_limit=0&list_offset=0&minimum_events=1&sort_by=distance&text=string&text_operator=AND&venue_limit=5&venue_offset=0&zero_terms_query=NONE' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Market: us' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Autocomplete

This endpoint is ideal for creating a list of choices as part of an autocomplete feature.

Using any of the parameters that ends with _limit will return that items for that resource in the response. It is possible to include multiple parameters to return multiple resources.

Request
query Parameters
activity_limit
integer >= 0

Limit the maximum number of activities to include in the response.

A positive value is required in order to receive activities in the response.

activity_offset
integer >= 0
Default: 0

Exclude the first N activities from the response, where N is the specified integer value.

category_limit
integer >= 0

Limit the maximum number of categories to include in the response.

A positive value is required in order to receive categories in the response.

category_offset
integer >= 0
Default: 0

Exclude the first N categories from the response, where N is the specified integer value.

city_limit
integer >= 0

Limit the maximum number of cities to include in the response.

A positive value is required in order to receive cities in the response.

city_offset
integer >= 0
Default: 0

Exclude the first N cities from the response, where N is the specified integer value.

coordinates
string(-)?\d{1,3}(\.\d+)?,(-)?\d{1,3}(\.\d+)?

Filter results using latitude and longitude, separated by a comma.

By itself, this parameter does not affect the results. Use the sort_by parameter to get results closest (or farthest) from the specified coordinates.

Results that do not contain coordinate data will not be affected by this parameter.

country_limit
integer >= 0

Limit the maximum number of countries to include in the response.

A positive value is required in order to receive countries in the response.

country_offset
integer >= 0
Default: 0

Exclude the first N countries from the response, where N is the specified integer value.

hotel_limit
integer >= 0

Limit the maximum number of hotels to include in the response.

A positive value is required in order to receive hotels in the response.

hotel_offset
integer >= 0
Default: 0

Exclude the first N hotels from the response, where N is the specified integer value.

list_limit
integer >= 0

Limit the maximum number of Musement lists to include in the response.

A positive value is required in order to receive lists in the response.

list_offset
integer >= 0
Default: 0

Exclude the first N Musement lists from the response, where N is the specified integer value.

pickup_limit
integer >= 0

Limit the maximum number of pickup points to include in the response.

A positive value is required in order to receive pickup points in the response.

pickup_offset
integer >= 0
Default: 0

Exclude the first N pickup points from the response, where N is the specified integer value.

sort_by
Array of strings

Sort results by one or more of the following values:

  • relevance: From lowest to highest relevance value.
  • -relevance: From highest to lowest relevance value.
  • distance: Results closest to the coordinates parameter appear first.
  • -distance: Results farthest from the coordinates parameter appear first.

This parameter will accept two values, separated with a comma.

Items which do not use relevance or coordinates will not be affected by this parameter.

Items Enum: distance -distance relevance -relevance
text
required
string >= 3 characters

Filter results to those which contain specified key words.

venue_limit
integer [ 0 .. 5 ]

Limit the maximum number of venues to include in the response.

A positive value is required in order to receive venues in the response.

Using a value greater than the maximum is ignored and the maximum number of possible results is used instead.

venue_offset
integer >= 0
Default: 0

Exclude the first N venues from the response, where N is the specified integer value.

header Parameters
Accept-Language
string (Language code)
Default: en-US

The value of this parameter might affect the language of the content in the response, provided a translation in the requested language is available.

X-Musement-Application
string (Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

X-Musement-Version
string^[0-9]+?.[0-9]+?.[0-9]+?$

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
Responses
200

Autocomplete results

400

Bad request: there are errors in the request

401

Unauthorized: token is not valid

503

Service unavailable

get/autocomplete
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/autocomplete?activity_limit=0&activity_offset=0&category_limit=0&category_offset=0&city_limit=0&city_offset=0&coordinates=string&country_limit=0&country_offset=0&hotel_limit=0&hotel_offset=0&list_limit=0&list_offset=0&pickup_limit=0&pickup_offset=0&sort_by=distance&text=string&venue_limit=5&venue_offset=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]