Cognite Data point subscriptions API
A data point subscription is a way to listen to changes to time series data points, in ingestion order.A single subscription can listen to many time series, and a time series can be part of many subscriptions.You listen to subscriptions by calling the âlist subscription dataâ endpoint. It will returna list of data point upserts and deleted ranges, together with a cursor to retrieve the nextbatch of updates. Updates written since the creation of the subscription, up to 7 days ago, can beretrieved through the subscription.Subscriptions can be defined explicitly through a list of time series external ids andinstance ids, or implicitly through a filter. The filter is a subset of the advanced filterquery in the regular âtime series searchâ endpoint.Partitions:Subscriptions can be further divided into a number of partitions, for the purpose offetching subscription data in parallel. Each partition will return data in ingestion order,but the order between partitions is not guaranteed.Limitations:- Each subscription can have at most 10000 time series.- A time series can be part of at most 10 subscriptions.- A project can have at most 1000 subscriptions, of which 100 are filter subscriptions.- Time series with security categories can not be shown in filter subscriptions.- Time series with neither external id nor instance id cannot be added to non-filter subscriptions.- The number of partitions cannot be changed after creation.Access control:You need READ access to subscriptions ACL to read/listsubscriptions or list data, and you need WRITE access to create/update/delete subscriptions.Furthermore, you need READ access to the time series you want to get updates from.For filter subscriptions, you either need READ access to all time series, or the filter mustbe restricted according to your access rights (e.g. by filtering on specific data set IDs).Subscriptions can have data sets that allow for more granular accesscontrol. The data set on a subscription does not influence the datastream, but allows you to restrict who can read/update the subscription.Name of ACL: `timeSeriesSubscriptionsAcl`Supported actions: - `READ` - `WRITE`Example capabilities:```[ {"timeSeriesAcl":{"actions":["READ"], "scope":{"all":{}}}}, {"timeSeriesSubscriptionsAcl":{"actions":["WRITE", "READ"], "scope":{"all":{}}}}]```
Cognite Data point subscriptions API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Data point subscriptions. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 7 operations across 6 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 5
Cognite Data point subscriptions API declares
5 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token).
It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope.
It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope.
It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope.
It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration.
By default, every request must be authenticated.
oidc-token— 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 acce…oauth2-client-credentials— 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 acce…oauth2-auth-code— 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 acce…oauth2-open-industrial-data— Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.org-oidc-token— Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…
Paths & Operations 7
Across 6 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
A data point subscription is a way to listen to changes to time series data points, in ingestion order. A single subscription can listen to many time series, and a time series can…
Schemas 48
The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are SubscriptionDTO (9 properties), SubscriptionsListDataRequest (8 properties), GetTimeSeriesForSubscription (5 properties), SubscriptionsListDataResponse (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cognite 12
Other APIs Cognite publishes across the network.
This is an independent, third-party profile of Cognite Data point subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.