We intend to effect 3 breaking changes to the Records API over the next couple of weeks of the Private Beta program. These changes may require updates of your test procedures.

/streams API

“settings” attribute will be required

Summary: Modifying the Cognite Streams API.

From when: After July 15, 2025

Description:

The Streams API provides a broad spectrum of functionalities, but it's important to understand that these capabilities are not mutually exclusive; enhancing one often means adjusting another. For instance, if a stream is designed for permanent data storage, it will offer unlimited record retention but a lower maximum ingestion rate. Conversely, streams built for temporary data staging will support significantly bigger ingestion rate but only for a brief retention period. Similarly, you'll choose between mutable streams (allowing record changes) and immutable streams (optimized for high volume and speed).

Because of these crucial distinctions, it's essential for users to be fully aware of the specific characteristics of the stream they are creating. To guarantee this clarity, all future create stream requests will require the explicit inclusion of the settings attribute. This means the previously optional settings attribute will become mandatory.

Sunset the “PrivateBeta“ settings template name

Summary: Sunset of stream request attribute

From when: After July 15, 2025

Description:

After July 15, 2025, it will not be possible to create a stream and specify the PrivateBeta settings template.

The PrivateBeta template was designed for experiments before we had use-case specific templates. The capabilities specified by the PrivateBeta template are too broad to support them efficiently. As a consequence, we will sunset this template, and users should use one of the alternative templates when creating a new stream.

Your previously created PrivateBeta streams will continue to work. However, any scripts specifying PrivateBeta as the stream settings can fail, and must be updated on or before July 15, 2025.

Note that since the PrivateBeta template represented the default settings template for a stream, it has been used regardless of whether you specified it in the settings attribute.

/records API

Renaming the aggregate response buckets

Summary: Modifying the Cognite Records API .

From when: After July 15, 2025

Description: 

Feedback from a user describing the issue:

The aggregate results are almost impossible for most JSON deserializers to deal with. It's hard to determine which aggregate variant to pick, since multiple just contain buckets . It would be much cleaner if instead of buckets you used the name of the aggregate type being returned, i.e. uniqueValues: [...], numberHistogramBuckets: [...] or something along those lines.

We plan to rename the buckets attribute for all Bucket aggregates, and will be using the following names:

• uniqueValues: uniqueValueBuckets

• numberHistogram: numberHistogramBuckets

• timeHistogram: timeHistogramBuckets

• filters: filterBuckets