List Events

filterstring nullable

Filter events following filter clauses. JSON string following the same schema a meter filter clause.

start_timestampstring date-time nullable

Filter events after this timestamp.

end_timestampstring date-time nullable

Filter events before this timestamp.

string uuid4

The organization ID.

OR

string[]

Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The customer ID.

OR

string[]

Filter by customer ID.

string

OR

string[]

Filter by external customer ID.

meter_idstring uuid4 nullable

The meter ID.

Filter by a meter filter clause.

string

OR

string[]

Filter by event name.

'system' | 'user'

OR

EventSource[]

Filter by event source.

querystring nullable

Query to filter events.

parent_idstring uuid4 nullable

The event ID.

When combined with depth, use this event as the anchor instead of root events.

depthinteger nullable

Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingEventSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

metadataobject nullable

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

v6

Query parameters

Response