Events
events
Methods
get/events
Retrieve a list of events.
Use the query parameter to filter events on key/value criteria.
Syntax:
key:value: matches events with metadata that contains a key namedkeywith a value ofvalue; use double quotes if the value contains spaces or special characterskey:value1,value2: matches events with metadata that contains a key namedkeywith a value of eithervalue1orvalue2key:*: matches events where any metadata that contains a key namedkey*:value: matches events where any metadata that containsvalueas a valuefoo: matches events with metadata where any key or value string containsfoo
Multiple qualifiers can be used in the same query string; this will filter events where metadata matches the intersection of the qualifiers (AND).
Examples:
key1:value1 key2:value2: matches metadata that contains both a key namedkey1with its valuevalue1and another key namedkey2with its valuevalue2key:"value with spaces": matches metadata with a key namedkeyand its valuevalue with spaceskey:value foo: matches metadata that contains both a key namedkeywith its valuevalueand any key or value that contains the textfoo
Note: The
startandendquery arguments will find any events which intersect the query range (inclusive of start and end).
post/events
Create a new event.
Note: Creating an new event currently requires a device ID or device
name, however the device field on the Event resource responses is
optional to allow future API expansion for attaching events to other
types of resources.
get/events/{id}
Get an event
Delete An Event -> { id }
delete/events/{id}
Delete an event
patch/events/{id}
Update an event
Domain types
Event = { id, createdAt, end, 5 more... }