Skip to main content
GET
/
events
/
{id}
JavaScript SDK
const events = await client.events.retrieve([{id: 123}, {externalId: 'abc'}]);
{
  "id": 4503599627370496,
  "lastUpdatedTime": 1730204346000,
  "createdTime": 1730204346000,
  "externalId": "my.known.id",
  "dataSetId": 4503599627370496,
  "startTime": 1730204346000,
  "endTime": 1730204346000,
  "type": "<string>",
  "subtype": "<string>",
  "description": "<string>",
  "metadata": {},
  "assetIds": [
    4503599627370496
  ],
  "source": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Path Parameters

​
id
integer<int64>
required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991

Response

response with list of events

An event represents something that happened at a given interval in time, for example, a failure, a work order, etc.

​
id
integer<int64>
required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991
​
lastUpdatedTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
createdTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
externalId
string

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Example:

"my.known.id"

​
dataSetId
integer<int64>

The id of the dataset this event belongs to.

Required range: 1 <= x <= 9007199254740991
​
startTime
integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
endTime
integer<int64>

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
type
string

Type of the event, e.g 'failure'.

Maximum string length: 64
​
subtype
string

SubType of the event, e.g 'electrical'.

Maximum string length: 64
​
description
string

Textual description of the event.

Maximum string length: 500
​
metadata
object

Custom, application specific metadata. String key -> String value. Limits: Maximum length of key is 128 bytes, value 128000 bytes, up to 256 key-value pairs, of total size at most 200000.

​
assetIds
integer<int64>[]

Asset IDs of equipment that this event relates to.

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991
​
source
string

The source of this event.

Maximum string length: 128
Last modified on May 13, 2026