Page Comparison

Page Properties

label	api_docs_events

Name	Events / Index
Description	Obtain a list of Events that match given conditions.
Type	GET
URL	/v9/events
Credential Type	API\|User
Supports Pagination	Yes

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.

Info
Note: You should not use the `list` method with a `name` parameter to search events as that will perform an exact match search. To search events first use the `/search` endpoint to search against your string and then list events using a `performer_id` or `venue_id` selected from your `/search` results.

Info
NOTE: For events in the Sandbox the seating chart URLs that contain `media.sandbox.ticketevolution.com` may not work. Simply changing that URL portion to `media.ticketevolution.com` should show a usable seating chart.

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 `true` and used in conjunction with `category_id` events in sub-categories of the `category_id` will be included.	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`		Decimal	Optional	Query	No
`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 `within`.	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 [d`ay` \| `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 Block

language

code

ruby
theme	Confluence

languageruby

{
   "current_page":1,
   "events":[
      {
         "products_eticket_count":0,
         "updated_at":"2013-02-19T22:29:13Z",
         "products_count":18,
         "owned_by_office":false,
         "long_term_popularity_score":0.44967,
         "venue":{
            "url":"/venues/6262",
            "name":"Liberty National Golf Club",
            "id":6262,
            "location":"Jersey City, NJ"
         },
         "configuration":{
            "fanvenues_key":null,
            "ticket_utils_id":null,
            "url":"/configurations/13110",
            "name":"General Admission",
            "id":13110,
            "seating_chart":{
               "medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
               "large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
            }
         },
         "popularity_score":"0",
         "category":{
            "url":"/categories/131",
            "id":"131",
            "parent":{
               "url":"/categories/24",
               "id":"24",
               "parent":{
                  "url":"/categories/1",
                  "id":"1",
                  "parent":null,
                  "name":"Sports"
               },
               "name":"Golf"
            },
            "name":"PGA"
         },
         "state":"shown",
         "url":"/events/376250",
         "name":"2013 Barclays Golf",
         "notes":null,
         "occurs_at":"2013-08-23T08:00:00Z",
         "id":376250,
         "performances":[
            {
               "performer":{
                  "url":"/performers/25395",
                  "name":"The Barclays Golf",
                  "id":25395
               },
               "primary":true
            }
         ]
      },
      {
         "products_eticket_count":0,
         "updated_at":"2013-02-19T22:29:13Z",
         "products_count":33,
         "owned_by_office":false,
         "long_term_popularity_score":0.43603,
         "venue":{
            "url":"/venues/6262",
            "name":"Liberty National Golf Club",
            "id":6262,
            "location":"Jersey City, NJ"
         },
         "configuration":{
            "fanvenues_key":null,
            "ticket_utils_id":null,
            "url":"/configurations/13110",
            "name":"General Admission",
            "id":13110,
            "seating_chart":{
               "medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
               "large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
            }
         },
         "popularity_score":"0",
         "category":{
            "url":"/categories/131",
            "id":"131",
            "parent":{
               "url":"/categories/24",
               "id":"24",
               "parent":{
                  "url":"/categories/1",
                  "id":"1",
                  "parent":null,
                  "name":"Sports"
               },
               "name":"Golf"
            },
            "name":"PGA"
         },
         "state":"shown",
         "url":"/events/376251",
         "name":"2013 Barclays Golf",
         "notes":null,
         "occurs_at":"2013-08-20T08:00:00Z",
         "id":376251,
         "performances":[
            {
               "performer":{
                  "url":"/performers/25395",
                  "name":"The Barclays Golf",
                  "id":25395
               },
               "primary":true
            }
         ]
      },
      {
         "products_eticket_count":0,
         "updated_at":"2013-02-19T22:29:13Z",
         "products_count":24,
         "owned_by_office":false,
         "long_term_popularity_score":0.4587,
         "venue":{
            "url":"/venues/6262",
            "name":"Liberty National Golf Club",
            "id":6262,
            "location":"Jersey City, NJ"
         },
         "configuration":{
            "fanvenues_key":null,
            "ticket_utils_id":null,
            "url":"/configurations/13110",
            "name":"General Admission",
            "id":13110,
            "seating_chart":{
               "medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
               "large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
            }
         },
         "popularity_score":"0",
         "category":{
            "url":"/categories/131",
            "id":"131",
            "parent":{
               "url":"/categories/24",
               "id":"24",
               "parent":{
                  "url":"/categories/1",
                  "id":"1",
                  "parent":null,
                  "name":"Sports"
               },
               "name":"Golf"
            },
            "name":"PGA"
         },
         "state":"shown",
         "url":"/events/376252",
         "name":"2013 Barclays Golf",
         "notes":null,
         "occurs_at":"2013-08-24T08:00:00Z",
         "id":376252,
         "performances":[
            {
               "performer":{
                  "url":"/performers/25395",
                  "name":"The Barclays Golf",
                  "id":25395
               },
               "primary":true
            }
         ]
      },
      {
         "products_eticket_count":0,
         "updated_at":"2013-02-19T22:29:13Z",
         "products_count":24,
         "owned_by_office":false,
         "long_term_popularity_score":0.45029,
         "venue":{
            "url":"/venues/6262",
            "name":"Liberty National Golf Club",
            "id":6262,
            "location":"Jersey City, NJ"
         },
         "configuration":{
            "fanvenues_key":null,
            "ticket_utils_id":null,
            "url":"/configurations/13110",
            "name":"General Admission",
            "id":13110,
            "seating_chart":{
               "medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
               "large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
            }
         },
         "popularity_score":"0",
         "category":{
            "url":"/categories/131",
            "id":"131",
            "parent":{
               "url":"/categories/24",
               "id":"24",
               "parent":{
                  "url":"/categories/1",
                  "id":"1",
                  "parent":null,
                  "name":"Sports"
               },
               "name":"Golf"
            },
            "name":"PGA"
         },
         "state":"shown",
         "url":"/events/376253",
         "name":"2013 Barclays Golf",
         "notes":null,
         "occurs_at":"2013-08-25T08:00:00Z",
         "id":376253,
         "performances":[
            {
               "performer":{
                  "url":"/performers/25395",
                  "name":"The Barclays Golf",
                  "id":25395
               },
               "primary":true
            }
         ]
      },
      {
         "products_eticket_count":0,
         "updated_at":"2013-02-19T22:29:13Z",
         "products_count":24,
         "owned_by_office":false,
         "long_term_popularity_score":0.45202,
         "venue":{
            "url":"/venues/6262",
            "name":"Liberty National Golf Club",
            "id":6262,
            "location":"Jersey City, NJ"
         },
         "configuration":{
            "fanvenues_key":null,
            "ticket_utils_id":null,
            "url":"/configurations/13110",
            "name":"General Admission",
            "id":13110,
            "seating_chart":{
               "medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
               "large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
            }
         },
         "popularity_score":"15.08",
         "category":{
            "url":"/categories/131",
            "id":"131",
            "parent":{
               "url":"/categories/24",
               "id":"24",
               "parent":{
                  "url":"/categories/1",
                  "id":"1",
                  "parent":null,
                  "name":"Sports"
               },
               "name":"Golf"
            },
            "name":"PGA"
         },
         "state":"shown",
         "url":"/events/376254",
         "name":"2013 Barclays Golf",
         "notes":null,
         "occurs_at":"2013-08-22T08:00:00Z",
         "id":376254,
         "performances":[
            {
               "performer":{
                  "url":"/performers/25395",
                  "name":"The Barclays Golf",
                  "id":25395
               },
               "primary":true
            }
         ]
      },
      {
         "products_eticket_count":0,
         "updated_at":"2013-02-19T22:29:13Z",
         "products_count":24,
         "owned_by_office":false,
         "long_term_popularity_score":0.42858,
         "venue":{
            "url":"/venues/6262",
            "name":"Liberty National Golf Club",
            "id":6262,
            "location":"Jersey City, NJ"
         },
         "configuration":{
            "fanvenues_key":null,
            "ticket_utils_id":null,
            "url":"/configurations/13110",
            "name":"General Admission",
            "id":13110,
            "seating_chart":{
               "medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
               "large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
            }
         },
         "popularity_score":"0",
         "category":{
            "url":"/categories/131",
            "id":"131",
            "parent":{
               "url":"/categories/24",
               "id":"24",
               "parent":{
                  "url":"/categories/1",
                  "id":"1",
                  "parent":null,
                  "name":"Sports"
               },
               "name":"Golf"
            },
            "name":"PGA"
         },
         "state":"shown",
         "url":"/events/376255",
         "name":"2013 Barclays Golf",
         "notes":null,
         "occurs_at":"2013-08-21T08:00:00Z",
         "id":376255,
         "performances":[
            {
               "performer":{
                  "url":"/performers/25395",
                  "name":"The Barclays Golf",
                  "id":25395
               },
               "primary":true
            }
         ]
      }
   ],
   "per_page":100,
   "total_entries":6
}

Versions Compared

Old Version 18

New Version 19

Key

Long Description

Parameters

Examples