Versions Compared

Old Version 19

changes.mady.by.user J Cobb

Saved on

compared with

New Version Current

changes.mady.by.user J Cobb

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...


Page Properties
labelapi_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.

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. 

...


...

Note

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.

...

Note

NOTE:

...

The seating_chart image URLs within the configuration object are deprecated and no longer updated. Instead, you should use our dynamic seating charts.


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)OptionalQueryYesupdated_atRefine dates at which the event was updated using an ISO 8601 formatted

.

Info

You can use occurs_at twice when using conditionals to retrieve events within a date range. For example, to retrieve only events within April 2018 use occurs_at.gte=2018-04-01&occurs_at.lt=2018-05-01


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

If primary_performer is true only events where  performer_id is the Primary performer for the event will be returned.

If primary_performer is false only events where  performer_id is the NOT the Primary performer for the event will be returned.

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

fuzzy

When true and used in conjunction with q will result in fuzzy full text search. Will NOT work if passed without q.

Boolean

Option

Query

No

lat

Latitude & longitude for geolocated searches. Control size of geolocation area using within. Must supply both.

Decimal

Optional

Query

No

lon

ip

within

Radius in miles for geolocated searches (default 15)

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.

This method of geolocation is not recommended.

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.

This method of geolocation is not recommended.

String

Optional

Query

No

withinRadius in miles for geolocated searches (default 15)Decimal

country_code

Provide an ISO 3166 Alpha-2 country code to have results filtered to that specific country.

String (2)

Optional

Query

No

only_with_tickets

Show only events that have inventory

String [ay

regardless of whether they are available for sale (All states will be shown). If you want only available tickets, use only_with_available_tickets

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

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".

tickets (tickets for sale). Pass with office_id for inventory belonging only to your office. 

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

Note

Deprecated. Use the Events/Stats endpoint instead.

Results will include avg_price, sum_price, median_price, min_price & max_price, calculated based on that Credential’s settings

Boolean 

Boolean 

Optional 

Query

No

Examples

only_discounted

If true then only events that have discounted tickets will be returned.

Boolean

Optional

Query

No


Examples

Request

Response

GET /v9/events?

city_state=jersey%20city,nj&within=2

performer_id=13910&occurs_at.gte=2023-08-19&occurs_at.lte=2023-08-21

Code Block
languageruby
themeConfluence
{
  
"current_page": 1,
  
"
events
per_page":
[
 100,
  "total_entries": 2,
{
 "events": [
    {
      "
products
available_
eticket_
count":
0, 
 811,
      "category": {
        "
updated_at
id":
"2013-02-19T22:29:13Z
 "4",
        "name": "
products_count":18
Minor League Baseball",
        "slug": "
owned_by_office":false
minor-league",
        "url": "
long_term_popularity_score":0.44967
/categories/4",
        
"
venue
slug_url":
{ 
 "/categories/minor-league",
        "
url
parent":
"/venues/6262",
 {
          
"
name
id":
"Liberty National Golf Club
 "2",
          "name": 
"
id
Baseball"
:6262
,
          
"
location
slug": "
Jersey City
baseball",
NJ"
}, 
"url": "/categories/2",
          "
configuration
slug_url":
{
 "/categories/baseball",
          
"
fanvenues_key
parent":
null,
 {
            "
ticket_utils_
id":
null
 "1",
            "
url
name": "
/configurations/13110
Sports",
            "
name
slug": "
General Admission
sports",
            "
id
url":
13110
 "/categories/1",
            "
seating
slug_
chart
url":
{ 
 "/categories/sports",
            "
medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg", 
parent": null
          }
"large":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
     }
      
},
      "configuration": {
}, 
       
"
popularity_score
id":
"0"
 11583,

        "
category
url":
{ 
 "/configurations/11583",
        
"
url
name": "
/categories/131
Baseball",
        "fanvenues_key": null,
        "ticket_utils_id":
"131", 
 null,
        
"
parent
seating_chart": {

          
"
url
medium": "
/categories/24
null",
"id
"large": "
24
null"
,

        }
"parent":{
},
      
"id": 2165591,
"url":"/categories/1"
"long_term_popularity_score": 0.216,
      "name": "Louisville Bats at Iowa Cubs",
      "
id
notes": "
1
",
"parent":null
"occurs_at_local": "2023-08-19T00:00:00-05:00",
      "occurs_at": "2023-08-19T00:00:00Z",
"name
"owned_by_office":
"Sports"
 false,
      "performances": [
},
  {
          
"
name
performer":
"Golf"
 {
            "id":
}
14029,
            "
name
slug": "
PGA" }, "state":"shown",
louisville-bats",
            "slug_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" 
performers/louisville-bats",
}
   
"url": "/performers/14029",
},
        
"
popularity_score
name":
"15.08",
 "Louisville Bats"
"category":{
  },
          "
url
primary":
"/categories/131",
 false
        },
"id":"131",
  {
          "
parent
performer": {
            
"
url
id":
"/categories/24", 
 13910,
            
"
id
slug": "
24
iowa-cubs",
"parent
"slug_url":
{ 
 "/performers/iowa-cubs",
            
"url": "/
categories
performers/
1
13910",
            "name": "Iowa Cubs"
"id":"1",
        },
          "
parent
primary":
null,
 true
        }
      ],
"name":"Sports"
     
"popularity_score": 2.78,
}
"products_count": 811,
      "products_eticket_count": 459,
      
"
name
promotion_label": "
Golf"
Brennen Davis Bobblehead Giveaway",
}, 
"state": "shown",
      
"
name
stubhub_id":
"PGA"
 null,
}, 
"updated_at": "2023-07-25T14:41:34Z",
      "
state
url": "
shown
/events/2165591",

      "
url
venue":
"/events/376254",
 {
        "
name
id":
"2013 Barclays Golf"
 4735,
        "slug": "
notes
principal-park"
:null
,

        "
occurs_at
url":
"2013-08-22T08:00:00Z
 "/venues/4735",
        "slug_url": "
id":376254, 
/venues/principal-park",
        "
performances
name":
[
 "Principal Park",
        "location": "Des
{ 
Moines, IA",
        
"
performer
time_zone":
{
 "America/Chicago"
      },
      "discount_magnitude": 0
"url":"/performers/25395"
 },
    {
      "available_count": 897,
      "
name
category":
"The Barclays Golf",
 {
        "id": "4",
        "
id
name":
25395
 "Minor League Baseball",
        "slug": "minor-league",
},
      "url": "/categories/4",
        "
primary
slug_url":
true
 "/categories/minor-league",
        "parent": {
}
        "id": "2",
]
},
   "name": "Baseball",
{
        "slug": 
"
products_eticket_count":0,
baseball",
          "
updated_at
url":
"2013-02-19T22:29:13Z
 "/categories/2",
          "
products
slug_
count
url":
24
 "/categories/baseball",
          "
owned_by_office
parent":
false,
 {
            "
long_term_popularity_score":0.42858,
id": "1",
            "
venue
name":
{
 "Sports",
            "
url
slug": "
/venues/6262
sports",
            "
name
url":
"Liberty National Golf Club
 "/categories/1",
            "
id
slug_url":
6262
 "/categories/sports",
            "
location
parent":
"Jersey
City,
null
NJ"
          }
,

        }
"configuration":{
      },
      "
fanvenues_key
configuration":
null,
 {
        
"
ticket_utils_
id":
null, 
 11583,
        
"url": "/configurations/
13110
11583",

        "name": "
General Admission
Baseball",

        "
id
fanvenues_key":
13110, 
 null,
        "
seating
ticket_utils_
chart
id":
{
 null,
        "seating_chart": {
"medium":"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_500.jpg",
        "medium": "null",
          "large":
"https://s3.amazonaws.com/media.ticketevolution.com/configurations/default_maps/ga_1000.jpg"
 "null"
        }
}
  },
      "id":
}
2165592,
"
"long_term_popularity_score":
"
 0
"
.172,
      
"
category
name":
{
 "Louisville Bats 
at Iowa Cubs",
      "
url
notes": "
/categories/131
",
      "occurs_at_local": "2023-08-20T00:00:00-05:00",
      "
id
occurs_at":
"131
 "2023-08-20T00:00:00Z",
      "owned_by_office": false,
      "
parent
performances":
{
 [
        {
"url":"/categories/24",
    "performer": {
            "id":
"24", 
 14029,
            
"
parent
slug":
{ 
 "louisville-bats",
            "slug_url": "/
categories
performers/
1
louisville-bats",
"id
"url": "
1
/performers/14029",
            "name": "Louisville Bats"
"parent":null,
       },
          
"
name
primary":
"Sports"
 
false
        },
},
     {
          "
name
performer":
"Golf"
 {
            "id":
}
13910,
            "
name
slug": "
PGA" 
iowa-cubs",
},
          "
state
slug_url":
"shown
 "/performers/iowa-cubs",
            "url": "/
events
performers/
376255
13910",
            "name":
"2013 Barclays Golf",
 "Iowa Cubs"
          },
          "
notes
primary":
null,
 true
        }
"occurs_at":"2013-08-21T08:00:00Z",
   ],
      "
id
popularity_score":
376255
 1.37,
      "products_count": 897,
"performances":[
     "products_eticket_count": 704,
{
 "promotion_label": null,
      "state": "shown",
      
"
performer
stubhub_id":
{
 null,
      
"updated_at": "2022-10-11T21:05:37Z",
      "url": "/
performers
events/
25395
2165592",
      "venue": {
        
"
name
id":
"The Barclays Golf"
 4735,
        "slug": "principal-park",
        "
id
url":
25395 
 "/venues/4735",
},
    
"slug_url": "/venues/principal-park",
        "
primary
name":
true 
 "Principal Park",
        "location": "Des Moines,
}
IA",
]
"time_zone": "America/Chicago"
      },
],
   
"
per
discount_
page
magnitude":
100,
 0
    }
"total_entries":6
 ]
}