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
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
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.