Additional Input Parameters

Find additional details about the input parameters for several endpoints.

We'll cover the following

Event search

The full details of all the parameters taken by the events endpoint are as follows:

Parameter

Type

Category

Description

id

string

optional

If provided, the search results are filtered by the event ID.

keyword

string

optional

A keyword on which the search is performed.

attractionId

string

optional

If provided, the search results are filtered by the attraction ID.

venueId

string

optional

If provided, the search results are filtered by the venue ID.

postalCode

string

optional

If provided, the search results are filtered by the postal code or the zipcode.

latlong

string

optional

If provided, the search results are filtered by latitude and longitude. This filter is deprecated and may be removed in a future release in favor of geoPoint.

radius

string

optional

The radius of the area in which we want to search for events.

unit

enum['miles', 'km']

optional

The unit of the radius. The default value is miles.

source

enum['ticketmaster', 'universe', 'frontgate', 'tmr']

optional

If provided, the search results are filtered by their primary source name or publishing source name.

locale

string

optional

The locale in ISO code format. Multiple comma-separated values can be provided. When omitting the country part of the code (e.g. only en or fr) then the first matching locale is used. When using * it matches all locales. The default value is en.

marketId

string

optional

If provided, the search results are filtered by the market ID.

startDateTime

string

optional

If provided, the search results are filtered to return events with a start date after this date.

endDateTime

string

optional

If provided, the search results are filtered to return events with a start date before this date.

includeTBA

enum['yes', 'no', 'only']

optional

If yes, events with a date that is yet to be announced (TBA) are included. If only, only events with a TBA date are returned.

includeTBD

enum['yes', 'no', 'only']

optional

If yes, events with a date that is yet to be defined (TBD) are included. If only, only events with a TBD date are returned.

includeTest

enum['yes', 'no', 'only']

optional

If yes, events flagged as test are included in the response. If only, only test entities will be returned.

size

number

optional

The number of results to be returned per page. The default value is 20.

page

number

optional

The page number to be returned. The default value is 0.

sort

string

optional

The sorting order of the search results. Allowable values are name,asc, name,desc, date,asc, date,desc, relevance,asc, relevance,desc, distance,asc, name,date,asc, name,date,desc, date,name,asc, date,name,desc, distance,date,asc, onSaleStartDate,asc, id,asc, venueName,asc, venueName,desc, random. The default value is relevance,desc.

onsaleStartDateTime

string

optional

If provided, the search results are filtered to return events with an onsale start date after this date.

onsaleEndDateTime

string

optional

If provided, the search results are filtered to return events with an onsale start date before this date.

city

string

optional

If provided, the search results are filtered based on the city.

countryCode

string

optional

If provided, the search results are filtered based on the country.

stateCode

string

optional

If provided, the search results are filtered based on the state code.

classificationName

array[string]

optional

If provided, the search results are filtered by classification name, that is, the name of any segment, genre, sub-genre, type, sub-type. Negative filtering is supported by using the following format '-'. (Negative filters may cause decreased performance.)

classificationId

array[string]

optional

If provided, the search results are filtered by classification ID, that is, the ID of any segment, genre, sub-genre, type, sub-type. Negative filtering is supported by using the following format '-'. (Negative filters may cause decreased performance.)

dmaId

string

optional

If provided, the search results are filtered based on the DMA ID.

localStartDateTime

array[string]

optional

If provided, the search results are filtered to return events with a local start date within this range.

localStartEndDateTime

array[string]

optional

If provided, the search results are filtered to return events with a local start and end date within this range.

startEndDateTime

array[string]

optional

If provided, the search results are filtered to return events with a start and end date within this range.

publicVisibilityStartDateTime

array[string]

optional

If provided, the search results are filtered to return events with public visibility starting from this date.

preSaleDateTime

array[string]

optional

If provided, the search results are filtered to return events with a presale start date within this date.

onsaleOnStartDate

string

optional

If provided, the search results are filtered to return events with an onsale start date on this date.

onsaleOnAfterStartDate

string

optional

If provided, the search results are filtered to return events with an onsale range within this date.

collectionId

array[string]

optional

If provided, the search results are filtered based on the collection IDs.

segmentId

array[string]

optional

If provided, the search results are filtered based on the segment IDs.

segmentName

array[string]

optional

If provided, the search results are filtered based on the segment names.

includeFamily

enum['yes', 'no', 'only']

optional

If yes, events that are family-friendly are included. If only, only family-friendly events are returned.

promoterId

string

optional

If provided, the search results are filtered based on the promoter ID.

genreId

array[string]

optional

If provided, the search results are filtered based on the genre ID.

subGenreId

array[string]

optional

If provided, the search results are filtered based on the sub-genre IDs.

typeId

array[string]

optional

If provided, the search results are filtered based on the type IDs.

subTypeId

array[string]

optional

If provided, the search results are filtered based on the sub-type IDs.

geoPoint

string

optional

If provided, the search results are filtered based on the geohash.

preferredCountry

enum['us', 'ca']

optional

The preferred country we want to find events in. The default value is us.

includeSpellcheck

enum['yes', 'no']

optional

If yes, spell check suggestions are included in the response.

domain

array[string]

optional

If provided, the search results are filtered based on the domain they are available on.

Attraction search

The full details of all the parameters accepted by the attractions endpoint are as follows:

Parameter

Type

Category

Description

id

string

optional

If provided, the search results are filtered by the attraction ID.

keyword

string

optional

A keyword on which the search is performed.

source

enum['ticketmaster', 'universe', 'frontgate', 'tmr']

optional

If provided, the search results are filtered by their primary source name or publishing source name.

locale

string

optional

The locale in ISO code format. Multiple comma-separated values can be provided. When omitting the country part of the code (e.g. only en or fr) then the first matching locale is used. When using * it matches all locales. The default value is en.

includeTest

enum['yes', 'no', 'only']

optional

If yes, attractions flagged as test are included in the response. If only, only test entities will be returned.

size

number

optional

The number of results to be returned per page. The default value is 20.

page

number

optional

The page number to be returned. The default value is 0.

sort

string

optional

The sorting order of the search results. Allowable values are name,asc, name,desc, date,asc, date,desc, relevance,asc, relevance,desc, distance,asc, name,date,asc, name,date,desc, date,name,asc, date,name,desc, distance,date,asc, onSaleStartDate,asc, id,asc, venueName,asc, venueName,desc, random. The default value is relevance,desc.

classificationName

array[string]

optional

If provided, the search results are filtered by classification name, that is, the name of any segment, genre, sub-genre, type, sub-type. Negative filtering is supported by using the following format '-'. (Negative filters may cause decreased performance.)

classificationId

array[string]

optional

If provided, the search results are filtered by classification ID, that is, the ID of any segment, genre, sub-genre, type, sub-type. Negative filtering is supported by using the following format '-'. (Negative filters may cause decreased performance.)

segmentId

array[string]

optional

If provided, the search results are filtered based on the segment IDs.

includeFamily

enum['yes', 'no', 'only']

optional

If yes, attractions that are family-friendly are included. If only, only family-friendly attractions are returned.

genreId

array[string]

optional

If provided, the search results are filtered based on the genre IDs.

subGenreId

array[string]

optional

If provided, the search results are filtered based on the sub-genre IDs.

typeId

array[string]

optional

If provided, the search results are filtered based on the type IDs.

subTypeId

array[string]

optional

If provided, the search results are filtered based on the sub-type IDs.

preferredCountry

enum['us', 'ca']

optional

The preferred country we want to find attractions in. The default value is us.

includeSpellcheck

enum['yes', 'no']

optional

If yes, spell check suggestions are included in the response.

domain

array[string]

optional

If provided, the search results are filtered based on the domain they are available on.

Venue search

The full details of all the parameters accepted by the venues endpoint are as follows:

Parameter

Type

Category

Description

id

string

optional

If provided, the search results are filtered by the venue ID.

keyword

string

optional

A keyword on which the search is performed.

latlong

string

optional

If provided, the search results are filtered by latitude and longitude. This filter is deprecated and may be removed in a future release in favor of geoPoint.

radius

string

optional

The radius of the area in which we want to search for venues.

unit

enum['miles', 'km']

optional

The unit of the radius. The default value is miles.

source

enum['ticketmaster', 'universe', 'frontgate', 'tmr']

optional

If provided, the search results are filtered by their primary source name or publishing source name.

locale

string

optional

The locale in ISO code format. Multiple comma-separated values can be provided. When omitting the country part of the code (e.g. only en or fr) then the first matching locale is used. When using * it matches all locales. The default value is en.

includeTest

enum['yes', 'no', 'only']

optional

If yes, venues flagged as test are included in the response. If only, only test entities will be returned.

size

number

optional

The number of results to be returned per page. The default value is 20.

page

number

optional

The page number to be returned. The default value is 0.

sort

string

optional

The sorting order of the search results. Allowable values are name,asc, name,desc, date,asc, date,desc, relevance,asc, relevance,desc, distance,asc, name,date,asc, name,date,desc, date,name,asc, date,name,desc, distance,date,asc, onSaleStartDate,asc, id,asc, venueName,asc, venueName,desc, random. The default value is relevance,desc.

countryCode

string

optional

If provided, the search results are filtered based on the country.

stateCode

string

optional

If provided, the search results are filtered based on the state code.

geoPoint

string

optional

If provided, the search results are filtered based on the geohash.

preferredCountry

enum['us', 'ca']

optional

The preferred country we want to find venues in. The default value is us.

includeSpellcheck

enum['yes', 'no']

optional

If yes, spell check suggestions are included in the response.

domain

array[string]

optional

If provided, the search results are filtered based on the domain they are available on.

Classification search

The full details of all the parameters accepted by the classifications endpoint are as follows:

Parameter

Type

Category

Description

id

string

optional

If provided, the search results are filtered by the classification ID.

keyword

string

optional

A keyword on which the search is performed.

source

enum['ticketmaster', 'universe', 'frontgate', 'tmr']

optional

If provided, the search results are filtered by their primary source name or publishing source name.

locale

string

optional

The locale in ISO code format. Multiple comma-separated values can be provided. When omitting the country part of the code (e.g. only en or fr) then the first matching locale is used. When using * it matches all locales. The default value is en.

includeTest

enum['yes', 'no', 'only']

optional

If yes, classifications flagged as test are included in the response. If only, only test entities will be returned.

size

integer

optional

The number of results to be returned per page. The default value is 20.

page

integer

optional

The page number to be returned. The default value is 0.

sort

string

optional

The sorting order of the search results. The default value is name,asc.

preferredCountry

enum['us', 'ca']

optional

The preferred country we want to find results in. The default value is us.

includeSpellcheck

enum['yes', 'no']

optional

If yes, spell check suggestions are included in the response.

domain

array[string]

optional

If provided, the search results are filtered based on the domain they are available on.

Find suggestions

The full details of all the parameters accepted by the suggest endpoint are as follows:

Parameter

Type

Category

Description

keyword

string

optional

A keyword on which the search is performed.

latlong

string

optional

If provided, the results are filtered by latitude and longitude. This filter is deprecated and may be removed in a future release in favor of geoPoint.

radius

string

optional

The radius of the area in which we want to search for events.

unit

enum['miles', 'km']

optional

The unit of the radius. The default value is miles.

source

enum['ticketmaster', 'universe', 'frontgate', 'tmr']

optional

If provided, the results are filtered by their primary source name or publishing source name.

locale

string

optional

The locale in ISO code format. Multiple comma-separated values can be provided. When omitting the country part of the code (e.g. only en or fr) then the first matching locale is used. When using * it matches all locales. The default value is en.

startEndDateTime

array[string]

optional

If provided, the results are filtered to return events with a start and end date within this range.

localStartEndDateTime

array[string]

optional

If provided, the results are filtered to return events with a local start and end date within this range.

includeTBA

enum['yes', 'no', 'only']

optional

If yes, events with a date that is yet to be announced (TBA) are included. If only, only events with a TBA date are returned. The default value is no if the localStartEndDateTime or startEndDateTime parameters are provided, yes otherwise.

includeTBD

enum['yes', 'no', 'only']

optional

If yes, events with a date that is yet to be defined (TBD) are included. If only, only events with a TBD date are returned. The default value is no if the localStartEndDateTime or startEndDateTime parameters are provided, yes otherwise.

includeTest

enum['yes', 'no', 'only']

optional

If yes, entities flagged as test are included in the response. If only, only test entities will be returned.

size

number

optional

The number of results to be returned per resource. The default value is 5.

countryCode

string

optional

If provided, the results are filtered based on the country.

segmentId

array[string]

optional

If provided, the results are filtered based on the segment IDs.

geoPoint

string

optional

If provided, the search results are filtered based on the geohash.

resource

array[string]

optional

Defines which resources to include in the response. It defaults to all resources, that is, ["attractions", "events", "venues", "products"].

preferredCountry

enum['us', 'ca']

optional

The preferred country we want to find events in. The default value is us.

includeSpellcheck

enum['yes', 'no']

optional

If yes, spell check suggestions are included in the response.

domain

array[string]

optional

If provided, the search results are filtered based on the domain they are available on.