Versions Compared

Old Version 24

changes.mady.by.user Manish Bardolia

Saved on

compared with

New Version 25

changes.mady.by.user Matt Coneybeare

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: typo


Page Properties
labelapi_docs_events


NameEvents / Index
DescriptionObtain a list of Events that match given conditions.
TypeGET
URL/v9/events
Credential TypeAPI|User
Supports PaginationYes


...

Name
Description
Type
Presence
LocationConditionals
venue_idVenue at which the event occursIntegerOptionalQueryNo
nameExact name of the event. Use Events / Search when searching for events by name.StringOptionalQueryNo
occurs_at

Refine dates at which the event occurs using an ISO 8601 formatted datetime.

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)OptionalQueryYes
updated_atRefine dates at which the event was updated using an ISO 8601 formatted datetimeDate (ISO_8601)OptionalQueryYes
popularity_scoreRefine long term popularity scoreDecimalOptionalQueryNo
short_term_popularity_scoreRefine short term popularity scoreDecimalOptionalQueryNo
office_idShow only events for which this office has ticketsIntegerOptionalQueryNo
performer_idShow only events at which this performer will performIntegerOptionalQueryNo
primary_performer

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.

BooleanOptionalQueryNo
category_idShow only events in this category (does not include sub-categories)IntegerOptionalQueryNo
category_tree

When true and used in conjunction with category_id events in sub-categories of the category_id will be included.

BooleanOptionalQueryNo
qFull-text search eventsStringOptionalQuery

No

fuzzyWhen true and used in conjunction with q will result in fuzzy full text search. Will NOT work if passed without q.BooleanOptionQueryNo
latLatitude & longitude for geolocated searches. Control size of geolocation area using within. Must supply both.DecimalOptionalQueryNo
lon
ipInfer lat and lon by location of IP address for geolocated searches.StringOptionalQueryNo
postal_codeInfer lat and lon by location of postal code for geolocated searches. Control size of geolocation area using within.StringOptionalQueryNo
city_state

Infer lat and lon by location of city and state for geolocated searches. Control size of geolocation area using within.

StringOptionalQueryNo
withinRadius in miles for geolocated searches (default 15)DecimalOptionalQueryNo
only_with_ticketsShow only events that have inventory irregardless regardless of whether they are available for sale (All states will be shown). If you want only available tickets, use only_with_available_ticketsString [all | etickets]OptionalQueryNo
by_timeShow only events whose start time is during the day (between 4 AM-4 PM) or night (otherwise)String [day | night]OptionalQueryNo
only_with_available_ticketsShow only events that have available tickets (tickets for sale). Pass with office_id for inventory belonging only to your office. BooleanOptionalQueryNo
order_byPass in the parameter that you want to order by and the sorting order (Ex. :order_by => "events.popularity_score DESC")String

Optional

QueryNo
min_and_max_price
Results will include avg_price, sum_price, median_price, min_price & max_price, calculated based on that Credential’s settingsBoolean Optional QueryNo

...