Cognite Time series API
A time series consists of a sequence of data points connected to asingle asset. For example, a water pump asset can have a temperature timeseries that records a data point in units of °C every second.A single asset can have several time series. The water pump could have additional time seriesmeasuring pressure within the pump, rpm, flow volume, power consumption, and more.Timeseries store data points as either numbers or strings. This is controlled by theis_string flag on the time series object. Numerical data points can be aggregatedbefore they are returned from a query (e.g., to find the average temperature fora day). String data points, on the other hand, can't be aggregated by CDF butcan store arbitrary information like states (e.g., âopenâ/âclosedâ) or more complexinformation (JSON).Cognite stores discrete data points, but the underlyingprocess measured by the data points can vary continuously. When interpolatingbetween data points, we can either assume that each value stays the same untilthe next measurement or linearly changes between the two measurements.The `isStep` flag controls this on the time series object. For example,if we estimate the average over a time containing two data points, the averagewill either be close to the first (`isStep`) or close to the mean of the two (not`isStep`).A data point stores a single piece of information, a number or astring, associated with a specific time. Data points are identified by their timestamps,measured in milliseconds since the unix epoch -- 00:00:00.000, January 1st, 1970.The time series service accepts timestamps in the range from 00:00:00.000, January 1st, 1900through 23:59:59.999, December 31st, 2099 (in other words, every millisecond in the twocenturies from 1900 to but not including 2100). Negative timestamps areused to define dates before 1970. Milliseconds is the finest time resolution supported by CDF, i.e.,fractional milliseconds are not supported. Leap seconds are not counted.Numerical data points can be aggregated before they are retrieved from CDF. This allows for faster queries by reducingthe amount of data transferred. You can aggregate data points by specifying oneor more aggregates (e.g., average, minimum, maximum) as well as the time granularityover which the aggregates should be applied (e.g., â1hâ for one hour).Aggregates are aligned to the start time modulo the granularity unit. For example, if youask for daily average temperatures since Monday afternoon last week, the firstaggregated data point will contain averages for Monday, the second for Tuesday,etc. Determining aggregate alignment without considering data point timestampsallows CDF to pre-calculate aggregates (e.g., to quickly return daily average temperaturesfor a year). Consequently, aggregating over 60 minutes can return a differentresult than aggregating over 1 hour because the two queries will be aligned differently.Asset references obtained from a time series - through its asset ID - may be invalid simplyby the non-transactional nature of HTTP. They are maintained in an eventually consistentmanner.
Cognite Time series API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Time Series. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 12 operations across 11 paths, and defines 124 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 Time series 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 12
Across 11 paths, the API surfaces 12 operations — 1 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.
A time series consists of a sequence of data points connected to a single asset. For example, a water pump asset can have a temperature time series that records a data point in un…
Schemas 124
The contract defines 124 schemas that model the data the API accepts and returns. The most detailed are GetTimeSeriesMetadataDTO (16 properties), Filter (15 properties), DatapointsQueryProperties (13 properties), PostTimeSeriesMetadataDTO (12 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 Time series 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.