Listing, Sorting and Filtering Live Events
This endpoint returns the list of live events in the specified project.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a field name, and optionally asc or desc.
Sorting is valid on the following fields: name, properties/created, properties/description, properties/lastModified, properties/resourceState
Filtering
There are two ways to filter the set of returned live events from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.
The $filter query parameter allows for live events to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: name, properties/created, properties/description, properties/lastModified, properties/resourceState
$label_key and $label are specific to querying live events based on their labels. Labels are a set of key-value pairs that can be used to identify live events with
any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of live events.
Examples:
?$top=10 - Returns only the first 10 live events from the list.
?$orderby=name desc - Sorts live events by name in descending order.
?$filter=name eq 'descriptive name' - Returns live events that match the provided name.
?$orderby=properties/created desc - Sorts live events by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z - Returns live events created after January 1, 2021.
?$filter=properties/resourceState eq 'Running' - Returns live events in the Running state.
?$label=studio=paravalley - Returns live events with the label studio set to paravalley.
?$label=release-date~2023 - Returns live events with the label release-date set to a value that contains 2023.
?$label_key=studio&label_key=release-date - Returns live events with any value set for the studio label and the release-date label.