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
.
Determine which events have tickets
Please note: products_count
for each event will modify the updated_at
timestamp for an event if the event had 0 tickets and then tickets are added or an event has tickets and then the products_count
is greater than 0.
SEO
The Ticket Evolution API comes with a powerful content management system in order to simplify your SEO efforts. Simply log into the settings app and manage your site content under "Manage Content". This information will be returned via a "show" event request so you can populate the relevant information on each page.
Parameters
Name | Description | Type | Presence | Location | Conditionals |
---|---|---|---|---|---|
venue_id | Venue at which the event occurs | Integer | Optional | Query | No |
name | Exact name of the event. Use Events / Search when searching for events by name. | String | Optional | Query | No |
occurs_at | Refine dates at which the event occurs using an ISO 8601 formatted datetime | Date (ISO_8601) | Optional | Query | Yes |
updated_at | Refine dates at which the event was updated using an ISO 8601 formatted datetime | Date (ISO_8601) | Optional | Query | Yes |
popularity_score | Refine long term popularity score | Decimal | Optional | Query | No |
short_term_popularity_score | Refine short term popularity score | Decimal | Optional | Query | No |
office_id | Show only events for which this office has tickets | Integer | Optional | Query | No |
performer_id | Show only events at which this performer will perform | Integer | Optional | Query | No |
primary_performer | When used with performer_id this will require that the performer_id is marked as a Primary performer for the event | Boolean | Optional | Query | No |
category_id | Show only events in this category (does not include sub-categories) | Integer | Optional | Query | No |
category_tree | When | Boolean | Optional | Query | No |
q | Full-text search events | String | Optional | Query | No |
lat | Latitude & longitude for geolocated searches. Control size of geolocation area using within . Must supply both. | Decimal | Optional | Query | No |
lon | |||||
ip | Infer lat and lon by location of IP address for geolocated searches. | String | Optional | Query | No |
postal_code | Infer lat and lon by location of postal code for geolocated searches. Control size of geolocation area using within . | String | Optional | Query | No |
city_state | Infer lat and lon by location of city and state for geolocated searches. Control size of geolocation area using | String | Optional | Query | No |
within | Radius in miles for geolocated searches (default 15) | Decimal | Optional | Query | No |
only_with_tickets | Show only events that have inventory | String [all | etickets ] | Optional | Query | No |
by_time | Show only events whose start time is during the day (between 4 AM-4 PM) or night (otherwise) | String [day | night ] | Optional | Query | No |
only_with_available_tickets | Show only events that have available tickets belonging to my office. Must also pass "office_id". | 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 |
min_and_max_price | Results will include avg_price , sum_price , median_price , min_price & max_price , calculated based on that Credential’s settings | Boolean | Optional | Query | No |
Examples
Request | Response |
---|---|
/v9/events?city_state=jersey%20city,nj&within=2 |
|
|
code
|
|