Events By Tag
Last Updated: .
List of all events in TicketLeap (except drafts and hidden events) that is tagged with TAG_SLUG.
URL
http://public-api.ticketleap.com/events/by/tag/TAG_SLUG?key=PUT_API_KEY_HERE
URL Keys
The Events By Tag method url contains the following keys:
- TAG_SLUG: a tag to search TicketLeap events for
API Key
All requests must include your personal API key in the query string. To obtain an API key, login to your account on TicketLeap. Choose "My Account" on the top bar, then select "API Key" from the menu.
Paging
The Events By Tag method accepts optional paging parameters in the query string. If these parameters are not included, the default values are used.
- page_num: Specifies the page to return. Default value is 1. First page is page 1.
- page_size: Specifies how many records to return in the page. Default value is 10. Maximum allowed value is 100.
To return the second page of 5, the request would look like this:
http://public-api.ticketleap.com/events/by/tag/TAG_SLUG?key=PUT_API_KEY_HERE&page_num=2&page_size=5
Filtering by Date
The Events By Tag method accepts optional date filter parameters in the query string. Dates must be in the format YYYY-MM-DDTHHMM or YYYY-MM-DD. If included only performances that meet the date criteria will be returned.
- dates_after: Excludes any previous dates.
- dates_before: Excludes any following dates.
To filter the Events By Tag method between March and July of 2011, the request would look like this:
http://public-api.ticketleap.com/events/by/tag/TAG_SLUG?key=PUT_API_KEY_HERE&dates_after=2011-03-01&dates_before=2011-07-01
Filtering by Event Category Options
The Events By Tag method accepts optional event category option parameters in the query string. The option ids must be a bar delimited list of the GUID(s) for each option by which to filter. If included the events returned will be filtered exclusively by category and inclusively by option.
- event_filters: A bar delimited list of category option ids.
To filter the Events By Tag method by two event category options, the request would look like this:
http://public-api.ticketleap.com/events/by/tag/TAG_SLUG?key=PUT_API_KEY_HERE&event_filters=EVENT_FILTER_OPTION_ID1|EVENT_FILTER_OPTION_ID2
Sorting
The Events By Tag method can be sorted by specifying an optional parameter.
- sort_by: Specifies what field to perform the sort on. Possible values are date and alpha, defaulting to alpha
By specifying a value of date you ensure that the result will be sorted by the start time of the earliest performance after applying the date filter.
Specifying a value of alpha will sort the result set by the event name.
To sort the Events By Tag method by the earliest performance date, the request would look like this:
http://public-api.ticketleap.com/events/by/tag/TAG_SLUG?key=PUT_API_KEY_HERE&sort_by=date
Lists of Objects
The Events By Tag method returns a list of objects and will include the following fields in the response:
- total_count: The total number of objects that match the query
- page_num: The page number of the subset of data that was returned
- page_size: The page size value used in generating the subset of data that was returned
Example
Try an example of the Events By Tag method:
http://public-api.ticketleap.com/events/by/tag/wooo?key=PUT_API_KEY_HERE