LogoDocumentation

Events

events

Methods

List Events -> OffsetPage<
Event
>
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 named key with a value of value; use double quotes if the value contains spaces or special characters
  • key:value1,value2: matches events with metadata that contains a key named key with a value of either value1 or value2
  • key:*: matches events where any metadata that contains a key named key
  • *:value: matches events where any metadata that contains value as a value
  • foo: matches events with metadata where any key or value string contains foo

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 named key1 with its value value1 and another key named key2 with its value value2
  • key:"value with spaces": matches metadata with a key named key and its value value with spaces
  • key:value foo: matches metadata that contains both a key named key with its value value and any key or value that contains the text foo

Note: The start and end query arguments will find any events which intersect the query range (inclusive of start and end).

Create An Event ->
Event
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.

Response fields
Event
Request example
200Example
Get An Event ->
Event
get/events/{id}

Get an event

Delete An Event -> { id }
delete/events/{id}

Delete an event

Update An Event ->
Event
patch/events/{id}

Update an event

Domain types

Event = { id, createdAt, end, 5 more... }