| Field | Type | Required | Description |
|---|---|---|---|
filter |
?string | ➖ | Filter events following filter clauses. JSON string following the same schema a meter filter clause. |
startTimestamp |
\DateTime | ➖ | Filter events after this timestamp. |
endTimestamp |
\DateTime | ➖ | Filter events before this timestamp. |
organizationId |
string|array|null | ➖ | Filter by organization ID. |
customerId |
string|array|null | ➖ | Filter by customer ID. |
externalCustomerId |
string|array|null | ➖ | Filter by external customer ID. |
meterId |
?string | ➖ | Filter by a meter filter clause. |
name |
string|array|null | ➖ | Filter by event name. |
source |
Components\EventSource|array|null | ➖ | Filter by event source. |
query |
?string | ➖ | Query to filter events. |
parentId |
?string | ➖ | When combined with depth, use this event as the anchor instead of root events. |
depth |
?int | ➖ | Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events. |
page |
?int | ➖ | Page number, defaults to 1. |
limit |
?int | ➖ | Size of a page, defaults to 10. Maximum is 100. |
sorting |
array<Components\EventSortProperty> | ➖ | 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. |
metadata |
array<string, string|int|bool|array> | ➖ | Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value. |