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 sets API

Data sets let you document and track data lineage, ensure data integrity, and allow 3rd parties to write their insights securely back to a Cognite Data Fusion (CDF) project.Data sets group and track data by its source. For example, a data set can contain all work orders originating from SAP. Typically, an organization will have one data set for each of its data ingestion pipelines in CDF.A data set consists of metadata about the data set, and the data objects that belong to the data set. Data objects, for example events, files, and time series, are added to a data set through the `dataSetId` field of the data object. Each data object can belong to only one data set.To learn more about data sets, see [getting started guide](https://docs.cognite.com/cdf/data_governance/concepts/datasets/)

Cognite Data sets API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Datasets. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 39 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}.

5 operations 5 paths 39 schemas 5 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 sets 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 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Data sets 5

Data sets let you document and track data lineage, ensure data integrity, and allow 3rd parties to write their insights securely back to a Cognite Data Fusion (CDF) project. Data…

POST
/datasets
Create data sets
createDataSets body → 200400
POST
/datasets/list
Filter data sets
listDataSets body → 200400
POST
/datasets/aggregate
Aggregate data sets
aggregateDataSets body → 200400
POST
/datasets/byids
Retrieve data sets
getDataSets body → 200400
POST
/datasets/update
Update data sets.
updateDataSets body → 200400

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are DataSetFilter (5 properties), DataSetSpec (5 properties), Error (4 properties), ObjectPatchAddRemoveDataSet (2 properties). Each schema is shown below with its type and property counts.

DataSetIdEither
ObjectPatchDataSet
object
Custom, application specific metadata. String key - String value. Limits of updated asset: Maximum length of key is 128 bytes, value 10240 bytes, up to 256 key…
DataSetPatch
object
Update applied to single data set
1 property 1 required
SetDataSetName
object
1 property 1 required
DataSetFilterRequest
DataSetAggregateRequest
Aggregation request of data sets. Filters exact field matching or timestamp ranges inclusive min and max.
SinglePatchString
object
Set a new value for the string, or remove the value.
DataSetAggregate
object
Aggregation group of data sets
1 property 1 required
SetDataSetDescription
object
1 property 1 required
DataSetIdEitherList
object
SinglePatchDataSetDescription
object
Cursor
object
Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that…
1 property
DataSetMetadata
object
Custom, application specific metadata. String key - String value. Limits: Maximum length of key is 128 bytes, value 10240 bytes, up to 256 key-value pairs, of…
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
ObjectPatchAddRemoveDataSet
object
2 properties
DataSetUpdateList
object
1 property 1 required
RemoveField
object
1 property 1 required
SinglePatchBoolean
object
1 property 1 required
CogniteInternalId
integer
A server-generated ID for the object.
DataSet
DataSetInternalId
object
1 property 1 required
SetStringField
object
1 property 1 required
DataSetFilter
object
Filter on data sets with strict matching.
5 properties
SinglePatchDataSetName
object
DataSetChangeByExternalId
DataSetSpecList
object
1 property 1 required
ObjectPatchSetDataSet
object
1 property 1 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
DataDataSetAggregate
object
1 property 1 required
DataSetListWithCursor
object
DataSetUpdate
Error
object
Cognite API error.
4 properties 2 required
DataSetChangeById
DataSetList
object
1 property 1 required
CogniteExternalIdPrefix
string
Filter by this (case-sensitive) prefix for the external ID.
EpochTimestampRange
object
Range between two timestamps (inclusive).
2 properties
DataSetSpec
object
5 properties
IgnoreUnknownIdsField
object
1 property
DataSetExternalId
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-data-sets-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 point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Data sets 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.