How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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}.

7 operations 6 paths 48 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

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.

Data point subscriptions 7

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…

POST
/timeseries/subscriptions
Create subscriptions
postSubscriptions body → 201
GET
/timeseries/subscriptions
List subscriptions
listSubscriptions 2 params → 200
GET
/timeseries/subscriptions/members
List subscription members
listSubscriptionMembers 3 params → 200
POST
/timeseries/subscriptions/byids
Retrieve subscriptions
getSubscriptionsByIds body → 200
POST
/timeseries/subscriptions/update
Update subscriptions
updateSubscriptions body → 200
POST
/timeseries/subscriptions/delete
Delete subscriptions
deleteSubscriptions body → 200400
POST
/timeseries/subscriptions/data/list
List subscription data
listSubscriptionData body → 200

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.

ListSubscriptionDTO
object
List of subscriptions.
1 property 1 required
CogniteInstanceId
object
The ID of an [instance in Cognite Data Models](https://docs.cognite.com/cdf/dm/dmconcepts/dmspacesinstancesinstance).
2 properties 2 required
TimeSeriesContainsAnyFilter
object
1 property 1 required
SubscriptionsDataPartitionRequestDTO
object
2 properties 1 required
TimeSeriesLeafFilter
object
Leaf filter.
TimeSeriesSearchFilter
object
1 property 1 required
SubscriptionsDataUpdateResponseDTO
object
3 properties
TimeSeriesContainsAllFilter
object
1 property 1 required
ListSubscriptionMemberDTOWithCursor
object
A list of member time series along with possible cursors to get the next page of result
2 properties 1 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
SubscriptionMemberDTO
object
3 properties
NotFoundResponse
object
1 property 1 required
ListSubscriptionDTOWithCursor
object
A list of subscriptions along with possible cursors to get the next page of result
2 properties 1 required
SubscriptionsUpdateRequest
object
1 property 1 required
SubscriptionsDataDeletesDTO
array
List of time ranges in which all data points were deleted.
TimeSeriesRangeValue
An upper or lower bound in a range filter.
NullableSinglePatchLong
The change that will be applied to the key.
CogniteInternalId
integer
A server-generated ID for the object.
SubscriptionsCreateRequest
object
1 property 1 required
SubscriptionsDeleteRequest
object
TimeSeriesFilterLanguage
object
A filter DSL (Domain Specific Language) to define advanced filter queries. At the top level, an advancedFilter expression is either a single Boolean filter or…
SubscriptionDTO
object
9 properties 4 required
TimeSeriesRangeFilter
object
1 property 1 required
TimeSeriesStringValue
string
A value that you wish to find in the provided property.
SubscriptionsListDataResponse
object
Subscription data along with cursors.
4 properties 3 required
TimeSeriesFilterProperty
array
The property on which you want to filter. May be either: - A single-element list that contains the name of one of the predefined top-level properties, in which…
TimeSeriesBoolFilter
object
A query that matches items matching boolean combinations of other queries. It is built by nesting one or more Boolean clauses, each of which is one of and, or,…
NullableSinglePatchString
The change that will be applied to the key.
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
DatapointStatus
object
The [status code]( ) of the datapoint. The most common status codes are:\ Good (0) (Default)\ Uncertain (1073741824)\ Bad (2147483648) Only one of code and sym…
2 properties
TimeSeriesValue
A value that you wish to find in the provided property.
SubscriptionFilterLanguage
object
A filter DSL (Domain Specific Language) to define advanced filter queries. At the top level, a filter expression is either a single Boolean filter or a single…
TimeSeriesEpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds. Can be negative to define dates befor…
TimeSeriesValues
array
One or more values that you wish to find in the provided properties.
TimeSeriesInFilter
object
1 property 1 required
DataSetId
integer
The dataSet Id for the item.
SubscriptionsListDataRequest
object
8 properties 1 required
TimeSeriesEqualsFilter
object
1 property 1 required
TimeSeriesType
string
The type of the time series. Currently, time series can either be of type numeric or string. The available types of time series may be extended in the future.
PostDatapoint
TimeSeriesExistsFilter
object
1 property 1 required
TimeSeriesPrefixFilter
object
1 property 1 required
DatapointsDeleteRange
object
2 properties 1 required
GetTimeSeriesForSubscription
object
5 properties 3 required
SubscriptionsByIdsRequest
object
1 required
SubscriptionsDataUpsertsDTO
array
List of data points inserted into the time series (possibly overwriting existing data).
SubscriptionLeafFilter
object
Leaf filter.
IgnoreUnknownIdsField
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-data-point-subscriptions-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data products API
Where this information came from

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.