...
...
...
...
Page Properties | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
Long Description
Possible Event States
The possible event states are shown
, postponed
, and canceled
.
TBD Events
TBD Events will be returned with an occurs_at
of 00:00:00
.
...
Note |
---|
Note: You should not use the list method with a |
...
Note |
---|
NOTE: The |
Parameters
Name | Description | Type | Presence | Location | |||
---|---|---|---|---|---|---|---|
| Venue at which the event occurs | Integer | Optional | Query | No | ||
| Exact name of the event. Use Events / Search when searching for events by name. | String | Optional | Query | No | ||
| Refine dates at which the event occurs using an ISO 8601 formatted datetime.
| Date (ISO_8601) | Optional | Query | Yes | ||
| Refine dates at which the event was updated using an ISO 8601 formatted datetime | Date (ISO_8601) | Optional | Query | Yes | ||
| Refine long term popularity score | Decimal | Optional | Query | No | ||
| Refine short term popularity score | Decimal | Optional | Query | No | ||
| Show only events for which this office has tickets | Integer | Optional | Query | No | ||
| Show only events at which this performer will perform | Integer | Optional | Query | No | ||
| If If | Boolean | Optional | Query | No | ||
| Show only events in this category (does not include sub-categories) | Integer | Optional | Query | No | ||
| When | Boolean | Optional | Query | No | ||
| Full-text search events | String | Optional | Query | No | ||
fuzzy | When |
q will result in fuzzy full text search. Will NOT work if passed |
without q. | Boolean | Option | Query | No | |
| Latitude & longitude for geolocated searches. Control size of geolocation area using | Decimal | Optional | Query | No |
| |||||
| Infer lat and lon by location of IP address for geolocated searches. | String | Optional | Query | No |
| Infer lat and lon by location of postal code for geolocated searches. Control size of geolocation area using | String | Optional | Query | No |
| Infer lat and lon by location of city and state for geolocated searches. Control size of geolocation area using | String | Optional | Query | No |
| Radius in miles for geolocated searches (default 15) | Decimal | Optional | Query | No |
| Show only events that have inventory regardless of whether they are available for sale (All states will be shown). If you want only available tickets, use | String [ | Optional | Query | No |
| Show only events whose start time is during the day (between 4 AM-4 PM) or night (otherwise) | String [d | Optional | Query | No |
| Show only events that have available tickets (tickets for sale). Pass with | Boolean | Optional | Query | No |
order_by | Pass in the parameter that you want to order by and the sorting order (Ex. :order_by => "events.popularity_score DESC") | String | Optional | Query | No |
| Results will include |
Boolean | Optional | Query | No |
Examples
Request | Response | ||||
---|---|---|---|---|---|
/v9/events?city_state=jersey%20city,nj&within=2 | |||||
|
|