List events optionally filtered on query parameters
Request throttling
This endpoint is meant for data analytics/exploration usage and is not suitable for high load data retrieval usage.
It is a subject of the new throttling schema (limited request rate and concurrency).
Please check Events resource description for more information.
Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100
Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
maxStartTime
integer <int64> (EpochTimestamp) >= 0
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
minEndTime
integer <int64> (EpochTimestamp) >= 0
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
maxEndTime
integer <int64> (EpochTimestamp) >= 0
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
minActiveAtTime
integer <int64> >= 0
Event is considered active from its startTime to endTime inclusive. If startTime is null, event is never active. If endTime is null, event is active from startTime onwards. activeAtTime filter will match all events that are active at some point from min to max, from min, or to max, depending on which of min and max parameters are specified.
maxActiveAtTime
integer <int64> >= 0
Event is considered active from its startTime to endTime inclusive. If startTime is null, event is never active. If endTime is null, event is active from startTime onwards. activeAtTime filter will match all events that are active at some point from min to max, from min, or to max, depending on which of min and max parameters are specified.
assetIds
string <jsonArray(int64)> (JsonArrayInt64)
Asset IDs of equipment that this event relates to. Format is list of IDs serialized as JSON array(int64). Takes [ 1 .. 100 ] of unique items.
Only include events that have a related asset in a subtree rooted at any of these assetIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.
Only include events that have a related asset in a subtree rooted at any of these assetExternalIds (including the roots given). If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.
Filter by this (case-sensitive) prefix for the external ID.
Example: externalIdPrefix=my.known.prefix
partition
string
Splits the data set into N partitions.
The attribute is specified as a "M/N" string, where M is a natural number in the interval of [1, N].
You need to follow the cursors within each partition in order to receive all the data.
The maximum number of allowed partitions (N) is 10.
Cognite rejects requests if you specify more than 10 partitions.
When Cognite enforces this behavior, the requests result in a 400 Bad Request status.
Example: partition=1/3
includeMetadata
boolean
Default: true
Whether the metadata field should be returned or not.
sort
Array of strings
Sort by an array of the selected fields. Syntax: ["<fieldname>:asc|desc"]. Default sort order is asc with short syntax: ["<fieldname>"].
Filter accepts the following field names:
dataSetId,
externalId,
type,
subtype,
startTime,
endTime,
createdTime,
lastUpdatedTime,
source,
description,
metadata.
Partitions are done independently of sorting, there's no guarantee on sort order between elements from different partitions.
Example: sort=endTime:desc
Responses
200
Paged response with list of events
400
The response for a bad request.
429
The response for too many requests (concurrency or rate throttling).
get/events
Request samples
JavaScript SDK
Python SDK
curl
const events =await client.events.list({filter:{startTime:{min:newDate('1 jan 2018')},endTime:{max:newDate('1 jan 2019')}}});