Search for Events
POST/statistics/events/search
Returns a list of Events with Companies based on the search query.
Request
- application/json
Body
Input data
The search query.
Responses
- 200
- 406
Events and Companies lists.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The guid of the Event.
The guid of the Company the Event belongs to.
The guid of the Location the Event belongs to.
The guid of the EventRefundSetting of the Event.
Possible values: <= 255 characters
The name of the Event.
Possible values: <= 65536 characters
The description of the Event.
Possible values: <= 1000 characters
Extra information added to the email sent to ticket buyers.
Possible values: [once
, repeating
]
The type of the Event. This is either "repeating" or just "once".
Possible values: [disabled
, normal
, sold_out
, refunding
, moving
]
Default value: normal
The current status of sale or refund of the Event. One can set the status of a Ticket Type here.
Possible values: <= 255 characters
Contact email for visitors.
Possible values: <= 255 characters
Contact phone for visitors.
Possible values: <= 255 characters
Contact url for visitors.
Possible values: <= 255 characters
The website of the Event.
The locale of the Event.
The currency of the Event
The category of the Event.
The subcategories of the Event.
The date after which the Ticket Types of this Event may be retrieved.
Whether to automatically remove Events from the Shops.
location
object
The guid of the Location
The guid of the Company of the Location.
Possible values: <= 255 characters
The name of the Location.
Possible values: <= 65535 characters
The description of the Location.
Possible values: <= 9999999999
The maximum capacity of people that can be at this Location. This number is strictly positive or 0 signaling an infinite capacity.
Possible values: >= -85
and <= 85
The latitude in LatLng format.
Possible values: >= -180
and <= 180
The longitude in LatLng format.
Possible values: <= 65536 characters
The address of this Location. This is free text, so it can be as large or small as desired.
Whether this Location should appear in the public listing.
The key of the seating chart. See Seats.io for more information.
The guid of the parent Location. In the case that the Location has a parent.
Whether the Location provides seating or not.
The time it was created.
The time it was last updated.
The time it was deleted.
company
object
The guid of the Company.
Possible values: <= 255 characters
The name of a Company. It should be unique.
The website of the Company.
Default value: en_GB
The locale of the Company.
The country the Company is based in.
Default value: Europe/Amsterdam
The timezone of the Company.
Whether the Company is verified.
Possible values: <= 3600
The time that Tickets / Products remain reserved. This is in minutes.
Possible values: <= 100000000
The time it takes until an Order expires.
Possible values: [allow
, allow_when_available
, auto_refund
]
Defines what to do when a payment comes in for an expired Order. allow
allows for payment after the Order expires. allow_when_available
only allows for payments after the Order expires when the Ticket / Product is still available. auto_refund
automatically refunds the payment if the Order is already expired.
Possible values: <= 16 characters
String added to the payout description.
eventDates
object[]
The guid of the EventDate
The guid of the Event for this EventDate.
The start of the date range.
The end of the date range. Must be later than start date.
Possible values: <= 255 characters
The Event key (See Seats.io).
Possible values: <= 255 characters
The Facebook event ID.
Whether an EventDate is seated or not.
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_refund_setting_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"email_info": "string",
"type": "once",
"status": "normal",
"visitor_contact_email": "user@example.com",
"visitor_contact_phone": "string",
"visitor_contact_url": "string",
"website": "string",
"locale": "en_GB",
"currency": "EUR",
"category": "string",
"subcategories": [
"string"
],
"retrievable_after": "string",
"auto-prune": true,
"location": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"capacity": 0,
"latitude": 0,
"longitude": 0,
"address": "string",
"public": true,
"seats_chart_key": "string",
"parent_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"seated": true,
"created_at": "string",
"updated_at": "string",
"deleted_at": "string"
},
"company": {
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"website": "string",
"locale": "en_GB",
"country": "string",
"timezone": "Europe/Amsterdam",
"verified": true,
"reservation_time": 0,
"order_expire_time": 0,
"order_expire_option": "allow",
"payout_reference": "string"
},
"eventDates": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"start": "string",
"end": "string",
"seats_event_key": "string",
"facebook_event_id": "string",
"seated": true
}
]
}
The search query is required, and must be a string.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}