Get event type and genre summary
Returns aggregate counts for event types and genres matching the supplied filters. The limit and offset parameters are accepted by the filter parser but are ignored by this endpoint.
/api/events/type-summaryoffsetinteger<int64>Legacy offset pagination. Integer value.
limitinteger<int64>Maximum number of results requested.
startstringStart date in YYYY-MM-DD format. Defaults to the current date when omitted.
endstringInclusive end date in YYYY-MM-DD format.
timestringEvent-time filter. The value must contain a start time and an end time, separated by a comma.
Supported time formats:
HH,HHfor hours in 24-hour format.HHMM,HHMMfor hours and minutes in 24-hour format.
Examples:
10,14matches events from 10:00 to 14:00.1030,1545matches events from 10:30 to 15:45.
The start time must be before the end time.
categoriesstringComma-separated list of one or more category IDs.
Available categories:
1— Culture2— Education3— Sports4— Leisure5— Family6— Society
Multiple categories can be combined using commas.
searchstringFull-text search query.
venuestringVenue name/text filter.
space_typesstringComma-separated space type values.
countriesstringComma-separated country codes.
postal_codestringComma-separated list of postal code patterns.
Use * as a wildcard for partial matching:
249*matches postal codes starting with249.*509matches postal codes ending with509.*608*matches postal codes containing608.249*,2348*,*6000*matches any of the specified patterns.
Without *, an exact match is performed.
titlestringTitle text filter.
citystringVenue city filter.
event_typesstringComma-separated event type IDs. Cannot be used together with genres.
genresstringComma-separated genre IDs. Cannot be used together with event_types.
tagsstringComma-separated tags.
accessibilitystringAccessibility filter. Syntax is interpreted by the API filter parser.
visitor_infosstringVisitor-information filter. Syntax is interpreted by the API filter parser.
agestringAge filter. Syntax is interpreted by the API filter parser.
pricestringPrice filter. Syntax is interpreted by the API filter parser.
lonnumber<double>Longitude used for radius filtering.
latnumber<double>Latitude used for radius filtering.
radiusnumber<double>Radius used for geographic filtering.
last_event_start_atstringCursor timestamp used with last_event_date_uuid for stable pagination.
last_event_date_uuidstringCursor event-date UUID used with last_event_start_at.
langstringLanguage/locale value accepted by the event filter.
week_startstringOptional week start date in YYYY-MM-DD format.
org_uuidsstringComma-separated organization UUID values.
venue_uuidsstringComma-separated venue UUID values.
space_uuidsstringComma-separated space UUID values.
event_uuidsstringComma-separated event UUID values.
geolist_regionstringGeographic region filter. Must contain exactly three comma-separated components (lon,lat,radius). Cannot be combined with portal.
portalstringPortal UUID filter. Cannot be combined with geolist_region.
Summary returned successfully.
total_event_countintegerrequiredtype_summaryGetEvents.SummaryEntry[]requiredShow propertiesHide properties
GetEvents.SummaryEntryidintegerrequiredcountintegerrequiredgenre_summaryGetEvents.SummaryEntry[]requiredShow propertiesHide properties
GetEvents.SummaryEntryidintegerrequiredcountintegerrequiredInvalid request or filter parameter.
objectInternal server error.
object