Verticals

Verticals are a type of macro category which group various parts of the catalog together based on similar characteristics.

They are considered deprecated.

Get verticalsDeprecated

Request
query Parameters
limit
integer <= 100
Default: 10

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

offset
integer >= 0
Default: 0

Exclude the first N results 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

Verticals

401

Unauthorized: token is not valid

404

Resource not found

503

Service unavailable

get/verticals
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/verticals?limit=10&offset=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Get verticalDeprecated

Request
path Parameters
verticalId
required
integer (Vertical ID) >= 1

The numeric ID of the vertical.

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

Vertical

401

Unauthorized: token is not valid

404

Resource not found

503

Service unavailable

get/verticals/{verticalId}
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/verticals/{verticalId}' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]

Search activities in verticalDeprecated

Request
path Parameters
verticalId
required
integer (Vertical ID) >= 1

The numeric ID of the vertical.

query Parameters
category
integer (Category ID) >= 1

Filter results by category.

city
integer (City ID) >= 1

The numeric ID of the city.

limit
integer [ 1 .. 100 ]
Default: 100

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

offset
integer >= 0
Default: 0

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

sort_by
string

Sort results by a specified property, from highest value to lowest.

Enum: category-relevance city-relevance external-relevance price rating relevance venue-relevance
venue
integer (Venue ID) >= 1

Filter results by venue. Resulting activities will be in the specified venue.

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-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

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

Activities in vertical

302

When the limit parameter is greater than the maximum, endpoint is redirected with limit={maximum}.

401

Unauthorized: token is not valid

404

Resource not found

503

Service unavailable

get/verticals/{verticalId}/activities
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/verticals/{verticalId}/activities?category=1&city=1&limit=100&offset=0&sort_by=category-relevance&venue=1' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Currency: USD' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[
  • {
    }
]

Search categories in verticalDeprecated

Request
path Parameters
verticalId
required
integer (Vertical ID) >= 1

The numeric ID of the vertical.

query Parameters
filtering_aware
integer

Filter results to categories which can or cannot be used as filters for special landing pages.

Enum: 0 1
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

Categories in vertical

302

When the limit parameter is greater than the maximum, endpoint is redirected with limit={maximum}.

401

Unauthorized: token is not valid

404

Resource not found

503

Service unavailable

get/verticals/{verticalId}/categories
Request samples
curl -i -X GET \
  'https://sandbox.musement.com/api/v3/verticals/{verticalId}/categories?filtering_aware=0' \
  -H 'Accept-Language: en-US' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0'
Response samples
application/json
[]