Cognite Statistics API
The Statistics API from Cognite — 3 operation(s) for statistics.
OpenAPI Specification
openapi: 3.1.0
info:
title: Cognite 3D Asset Mapping Statistics API
description: "# Introduction\nThis is the reference documentation for the Cognite API with\nan overview of all the available methods.\n\n# Postman\nSelect the **Download** button to download our OpenAPI specification to get started.\n\nTo import your data into Postman, select **Import**, and the Import modal opens.\nYou can import items by dragging or dropping files or folders. You can choose how to import your API and manage the import settings in **View Import Settings**.\n\nIn the Import Settings, set the **Folder organization** to **Tags**, select\n**Enable optional parameters** to turn off the settings, and select **Always inherit authentication** to turn on the settings. Select **Import**.\n\nSet the Authorization to **Oauth2.0**. By default, the settings are for Open Industrial Data. Navigate to [Cognite Hub](https://hub.cognite.com/open-industrial-data-211) to understand how to get the credentials for use in Postman.\n\nFor more information, see [Getting Started with Postman](https://developer.cognite.com/dev/guides/postman/).\n\n# Pagination\nMost resource types can be paginated, indicated by the field `nextCursor` in the response.\nBy passing the value of `nextCursor` as the cursor you will get the next page of `limit` results.\nNote that all parameters except `cursor` has to stay the same.\n\n# Parallel retrieval\nAs general guidance, Parallel Retrieval is a technique that should be used when due to query complexity, retrieval of data in a single request is significantly slower than it would otherwise be for a simple request. Parallel retrieval does not act as a speed multiplier on optimally running queries. By parallelizing such requests, data retrieval performance can be tuned to meet the client application needs. \n\nCDF supports parallel retrieval through the `partition` parameter, which has the format `m/n` where `n` is the amount of partitions you would like to split the entire data set into.\nIf you want to download the entire data set by splitting it into 10 partitions, do the following in parallel with `m` running from 1 to 10:\n - Make a request to `/events` with `partition=m/10`.\n - Paginate through the response by following the cursor as explained above. Note that the `partition` parameter needs to be passed to all subqueries.\n\nProcessing of parallel retrieval requests is subject to concurrency quota availability. The request returns the `429` response upon exceeding concurrency limits. See the Request throttling chapter below.\n\nTo prevent unexpected problems and to maximize read throughput, you should at most use 10 partitions. \nSome CDF resources will automatically enforce a maximum of 10 partitions.\nFor more specific and detailed information, please read the ```partition``` attribute documentation for the CDF resource you're using. \n\n# Requests throttling\nCognite Data Fusion (CDF) returns the HTTP `429` (too many requests) response status code when project capacity exceeds the limit.\n\nThe throttling can happen:\n - If a user or a project sends too many (more than allocated) concurrent requests.\n - If a user or a project sends a too high (more than allocated) rate of requests in a given amount of time.\n\nCognite recommends using a retry strategy based on truncated exponential backoff to handle sessions with HTTP response codes 429.\n\nCognite recommends using a reasonable number (up to 10) of `Parallel retrieval` partitions.\n\nFollowing these strategies lets you slow down the request frequency to maximize productivity without having to re-submit/retry failing requests.\n\nSee more [here](https://docs.cognite.com/dev/concepts/resource_throttling).\n\n# API versions\n## Version headers\nThis API uses calendar versioning, and version names follow the `YYYYMMDD` format.\nYou can find the versions currently available by using the version selector at the top of this page.\n\nTo use a specific API version, you can pass the `cdf-version: $version` header along with your requests to the API.\n\n## Beta versions\nThe beta versions provide a preview of what the stable version will look like in the future.\nBeta versions contain functionality that is reasonably mature, and highly likely to become a part of the stable API.\n\nBeta versions are indicated by a `-beta` suffix after the version name. For example, the beta version header for the\n2023-01-01 version is then `cdf-version: 20230101-beta`.\n\n## Alpha versions\nAlpha versions contain functionality that is new and experimental, and not guaranteed to ever become a part of the stable API.\nThis functionality presents no guarantee of service, so its use is subject to caution.\n\nAlpha versions are indicated by an `-alpha` suffix after the version name. For example, the alpha version header for\nthe 2023-01-01 version is then `cdf-version: 20230101-alpha`."
version: v1
contact:
name: Cognite Support
url: https://support.cognite.com
email: support@cognite.com
servers:
- url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
description: The URL for the CDF cluster to connect to
variables:
cluster:
enum:
- api
- az-tyo-gp-001
- az-eastus-1
- az-power-no-northeurope
- westeurope-1
- asia-northeast1-1
- gc-dsm-gp-001
default: api
description: The CDF cluster to connect to
project:
default: publicdata
description: The CDF project name.
security:
- oidc-token:
- https://{cluster}.cognitedata.com/.default
- oauth2-client-credentials:
- https://{cluster}.cognitedata.com/.default
- oauth2-open-industrial-data:
- https://api.cognitedata.com/.default
- oauth2-auth-code:
- https://{cluster}.cognitedata.com/.default
tags:
- name: Statistics
paths:
/models/statistics:
get:
tags:
- Statistics
summary: Retrieve project-wide statistics and limits
description: '
> **Required capabilities:** `dataModelsAcl:READ`
Returns statistics and limits for data modeling resources across the project. Use this endpoint to monitor your overall data modeling usage and available capacity.'
operationId: getStatistics
x-capability:
- dataModelsAcl:READ
responses:
'200':
description: Statistics and limits for data modeling related resources in the project
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectStatistics'
'400':
$ref: '#/components/responses/ErrorResponse'
/models/statistics/spaces:
get:
tags:
- Statistics
summary: Retrieve statistics by space
description: '
> **Required capabilities:** `dataModelsAcl:READ`
Returns statistics for data modeling resources grouped by each space in the project.'
operationId: getSpaceStatistics
x-capability:
- dataModelsAcl:READ
responses:
'200':
description: List of spaces with associated data modeling statistics
content:
application/json:
schema:
$ref: '#/components/schemas/SpaceStatisticsResponseList'
'400':
$ref: '#/components/responses/ErrorResponse'
/models/statistics/spaces/byids:
post:
tags:
- Statistics
summary: Retrieve statistics by space for specific space-ids
description: '
> **Required capabilities:** `dataModelsAcl:READ`
Returns statistics for data modeling resources grouped by space for a specified list of spaces.'
operationId: getSpaceStatisticsByIds
requestBody:
description: List of space-ids to return statistics for.
content:
application/json:
schema:
$ref: '#/components/schemas/ListOfSpaceIdsRequest'
required: true
x-capability:
- dataModelsAcl:READ
responses:
'200':
description: List of spaces with associated data modeling statistics
content:
application/json:
schema:
$ref: '#/components/schemas/SpaceStatisticsResponseList'
'400':
$ref: '#/components/responses/ErrorResponse'
components:
schemas:
ProjectStatistics:
title: ProjectStatistics
description: Statistics and limits for data modeling related resources in a project
type: object
required:
- spaces
- containers
- views
- dataModels
- containerProperties
- instances
- concurrentReadLimit
- concurrentWriteLimit
- concurrentDeleteLimit
properties:
spaces:
description: Usage and limits for spaces in the project
allOf:
- $ref: '#/components/schemas/CountAndLimit'
containers:
description: Usage and limits for containers in the project
allOf:
- $ref: '#/components/schemas/CountAndLimit'
views:
description: Usage and limits for views including all versions in the project
allOf:
- $ref: '#/components/schemas/CountAndLimit'
dataModels:
description: Usage and limits for data models including all versions in the project
allOf:
- $ref: '#/components/schemas/CountAndLimit'
containerProperties:
description: Usage and limits for sum of container properties in the project
allOf:
- $ref: '#/components/schemas/CountAndLimit'
instances:
description: Usage and limits for number of instances in the project
allOf:
- $ref: '#/components/schemas/InstancesCountsAndLimits'
concurrentReadLimit:
type: integer
description: Maximum number of concurrent read operations allowed in the project
concurrentWriteLimit:
type: integer
description: Maximum number of concurrent write operations allowed in the project
concurrentDeleteLimit:
type: integer
minimum: 1
description: Maximum number of concurrent delete operations allowed in the project
recordsOnlyContainers:
description: Usage and limits for records-only containers in the project
allOf:
- $ref: '#/components/schemas/CountAndLimit'
recordsOnlyContainerProperties:
description: Usage and limits for sum of records-only container properties in the project
allOf:
- $ref: '#/components/schemas/CountAndLimit'
SpaceStatistics:
type: object
title: SpaceStatistics
description: Space-id with associated data modeling statistics
required:
- space
- containers
- views
- dataModels
- edges
- softDeletedEdges
- nodes
- softDeletedNodes
properties:
space:
type: string
description: The space name
containers:
type: integer
description: Number of containers in the space
views:
type: integer
description: Number of views including all versions in the space
dataModels:
type: integer
description: Number of data models including all versions in the space
edges:
type: integer
format: int64
description: Number of edges in the space
softDeletedEdges:
type: integer
format: int64
description: Number of soft-deleted edges in the space
nodes:
type: integer
format: int64
description: Number of nodes in the space
softDeletedNodes:
type: integer
format: int64
description: Number of soft-deleted nodes in the space
containerProperties:
type: integer
description: Number of container properties in the space
recordsOnlyContainers:
type: integer
description: Number of records-only containers in the space
recordsOnlyContainerProperties:
type: integer
description: Number of records-only container properties in the space
CountAndLimit:
description: Current count and associated limit for a specific resource in a project
type: object
required:
- count
- limit
properties:
count:
type: integer
limit:
type: integer
SpaceStatisticsResponseList:
type: object
required:
- items
properties:
items:
type: array
items:
$ref: '#/components/schemas/SpaceStatistics'
ListOfSpaceIdsRequest:
type: object
required:
- items
properties:
items:
type: array
minItems: 1
maxItems: 100
items:
type: object
required:
- space
properties:
space:
description: Ids for the spaces to perform operations on
allOf:
- $ref: '#/components/schemas/SpaceSpecification'
SpaceSpecification:
type: string
pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$
minLength: 1
maxLength: 43
InstancesCountsAndLimits:
description: Statistics and limits of the number of instances in a project
type: object
required:
- edges
- softDeletedEdges
- nodes
- softDeletedNodes
- instances
- instancesLimit
- softDeletedInstances
- softDeletedInstancesLimit
properties:
edges:
type: integer
format: int64
description: Number of edges in the project
softDeletedEdges:
type: integer
format: int64
description: Number of soft-deleted edges in the project
nodes:
type: integer
format: int64
description: Number of nodes in the project
softDeletedNodes:
type: integer
format: int64
description: Number of soft-deleted nodes in the project
instances:
type: integer
format: int64
description: Total number of instances in the project
instancesLimit:
type: integer
format: int64
description: Maximum number of instances allowed in the project
softDeletedInstances:
type: integer
format: int64
description: Total number of soft-deleted instances in the project
softDeletedInstancesLimit:
type: integer
format: int64
description: Maximum number of soft-deleted instances allowed in the project
Error:
type: object
required:
- code
- message
description: Cognite API error.
properties:
code:
type: integer
description: HTTP status code.
format: int32
example: 401
message:
type: string
description: Error message.
example: Could not authenticate.
missing:
type: array
description: List of lookup objects that do not match any results.
items:
type: object
additionalProperties: true
duplicated:
type: array
description: List of objects that are not unique.
items:
type: object
additionalProperties: true
responses:
ErrorResponse:
description: The response for a failed request.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
$ref: '#/components/schemas/Error'
securitySchemes:
oidc-token:
type: http
scheme: bearer
bearerFormat: OpenID Connect or OAuth2 token
description: 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 accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
oauth2-client-credentials:
type: oauth2
description: 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 accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
flows:
clientCredentials:
tokenUrl: https://your-idps.token.url/
scopes:
default: https://{cluster}.cognitedata.com/.default
oauth2-auth-code:
type: oauth2
description: 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 accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
flows:
authorizationCode:
authorizationUrl: https://your-idps.authorization.url/
tokenUrl: https://your-idps.token.url/
scopes:
default: https://{cluster}.cognitedata.com/.default
oauth2-open-industrial-data:
type: oauth2
description: Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
flows:
clientCredentials:
tokenUrl: https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token
scopes:
default: https://api.cognitedata.com/.default
org-oidc-token:
type: openIdConnect
openIdConnectUrl: https://auth.cognite.com/.well-known/openid-configuration
description: '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 obtained by performing an OIDC login flow toward `auth.cognite.com`.
This is a single URL for all CDF organizations.'
x-tagGroups:
- name: Changelog
tags:
- Changelog
- name: Organizations and projects
tags:
- Organizations
- Projects
- name: Identity and access management
tags:
- Principals
- Groups
- Security categories
- Sessions
- Token
- User profiles
- Project Deletion Reporting
- name: Data modeling
tags:
- Data Modeling
- Data models
- Spaces
- Views
- Containers
- Nodes
- Instances
- Statistics
- Streams
- Records
- name: Asset-centric data model
tags:
- Assets
- Time series
- Synthetic Time Series
- Data point subscriptions
- Events
- Files
- Sequences
- Geospatial
- Seismic
- name: 3D
tags:
- 3D Models
- 3D Model Revisions
- 3D Files
- 3D Asset Mapping
- 3D Contextualization
- 3D Jobs
- 3D Migration
- 3D Scenes
- name: Contextualization
tags:
- Entity matching
- Entity matching pipelines
- Engineering diagrams
- Vision
- Advanced joins
- name: Cognite AI
tags:
- Agents
- Skills
- Chat Completions
- Document AI
- Models
- name: Documents
tags:
- Documents
- Document preview
- name: Data ingestion
tags:
- Raw
- Extraction Pipelines
- Extraction Pipelines Runs
- Extraction Pipelines Config
- Extractors
- name: Data organization
tags:
- Data sets
- Data domains
- Data products
- Rule sets
- Labels
- Relationships
- Annotations
- name: Transformations
tags:
- Transformations
- Transformation Jobs
- Transformation Schedules
- Transformation Notifications
- Query
- Schema
- name: Functions
tags:
- Functions
- Function calls
- Function schedules
- name: Hosted Extractors
tags:
- Sources
- Jobs
- Destinations
- Mappings
- name: PostgreSQL Gateway
tags:
- Postgres Gateway Users
- Postgres Gateway Tables
- name: SAP Writeback
tags:
- SAP Instances
- SAP Endpoints
- Schema Mappings
- Writeback Requests
- name: Data workflows
tags:
- Workflows
- Workflow versions
- Workflow executions
- Workflow triggers
- Tasks
- Workers
- name: Simulators
tags:
- Simulators
- Simulator Integrations
- Simulator Models
- Simulator Routines
- Simulation Runs
- Simulator Logs
- name: Units
tags:
- Units
- Unit Systems
- name: ''
tags:
- ''