Statistics

AsyncCogniteClient.data_modeling.statistics.project()

Retrieve project-wide usage data and limits.

AsyncCogniteClient.data_modeling.statistics.spaces.list()

Retrieve usage for all spaces.

AsyncCogniteClient.data_modeling.statistics.spaces.retrieve(space)

Retrieve usage data and limits per space.

Data modeling statistics data classes

class cognite.client.data_classes.data_modeling.statistics.CountLimit(count: int, limit: int)

Bases: CogniteResource

Usage and limits for a specific resource in the data modeling API.

count

The current usage count for the resource.

Type:

int

limit

The maximum allowed limit for the resource.

Type:

int

class cognite.client.data_classes.data_modeling.statistics.InstanceStatistics(
edges: int,
soft_deleted_edges: int,
nodes: int,
soft_deleted_nodes: int,
instances: int,
instances_limit: int,
soft_deleted_instances: int,
soft_deleted_instances_limit: int,
)

Bases: CogniteResource

Statistics for instances in the data modeling API.

edges

Number of edges in the project.

Type:

int

soft_deleted_edges

Number of soft-deleted edges in the project.

Type:

int

nodes

Number of nodes in the project.

Type:

int

soft_deleted_nodes

Number of soft-deleted nodes in the project.

Type:

int

instances

Total number of instances in the project.

Type:

int

instances_limit

Maximum number of instances allowed in the project.

Type:

int

soft_deleted_instances

Total number of soft-deleted instances in the project.

Type:

int

soft_deleted_instances_limit

Maximum number of soft-deleted instances allowed in the project.

Type:

int

class cognite.client.data_classes.data_modeling.statistics.ProjectStatistics(
spaces: CountLimit,
containers: CountLimit,
views: CountLimit,
data_models: CountLimit,
container_properties: CountLimit,
instances: InstanceStatistics,
concurrent_read_limit: int,
concurrent_write_limit: int,
concurrent_delete_limit: int,
)

Bases: CogniteResource

Statistics for a project in the data modeling API.

spaces

Usage and limits for spaces in the project

Type:

CountLimit

containers

Usage and limits for containers in the project

Type:

CountLimit

views

Usage and limits for views including all versions in the project

Type:

CountLimit

data_models

Usage and limits for data models including all versions in the project

Type:

CountLimit

container_properties

Usage and limits for sum of container properties in the project

Type:

CountLimit

instances

Usage and limits for number of instances in the project

Type:

InstanceStatistics

concurrent_read_limit

Maximum number of concurrent read operations allowed in the project

Type:

int

concurrent_write_limit

Maximum number of concurrent write operations allowed in the project

Type:

int

concurrent_delete_limit

Maximum number of concurrent delete operations allowed in the project

Type:

int

dump(camel_case: bool = True) dict[str, Any]

Dump the instance into a json serializable Python data type.

Parameters:

camel_case (bool) – Use camelCase for attribute names. Defaults to True.

Returns:

A dictionary representation of the instance.

Return type:

dict[str, Any]

class cognite.client.data_classes.data_modeling.statistics.SpaceStatistics(
space: str,
containers: int,
views: int,
data_models: int,
edges: int,
soft_deleted_edges: int,
nodes: int,
soft_deleted_nodes: int,
)

Bases: CogniteResource

Statistics for a space in the data modeling API.

space

The space name

Type:

str

containers

Number of containers in the space.

Type:

int

views

Number of views in the space.

Type:

int

data_models

Number of data models in the space.

Type:

int

nodes

Number of nodes in the space.

Type:

int

edges

Number of edges in the space.

Type:

int

soft_deleted_nodes

Number of soft-deleted nodes in the space.

Type:

int

soft_deleted_edges

Number of soft-deleted edges in the space.

Type:

int

class cognite.client.data_classes.data_modeling.statistics.SpaceStatisticsList(
resources: Sequence[T_CogniteResource],
)

Bases: CogniteResourceList[SpaceStatistics]