Aggregate Event Unique Properties

async AsyncCogniteClient.events.aggregate_unique_properties(
path: EventProperty | str | list[str],
advanced_filter: Filter | dict[str, Any] | None = None,
aggregate_filter: AggregationFilter | dict[str, Any] | None = None,
filter: EventFilter | dict[str, Any] | None = None,
) → UniqueResultList

Get unique paths with counts for events.

Parameters:

  • path (EventPropertyLike) – The scope in every document to aggregate properties. The only value allowed now is [“metadata”]. It means to aggregate only metadata properties (aka keys).

  • advanced_filter (Filter | dict[str, Any] | None) – The filter to narrow down the events to count cardinality.

  • aggregate_filter (AggregationFilter | dict[str, Any] | None) – The filter to apply to the resulting buckets.

  • filter (EventFilter | dict[str, Any] | None) – The filter to narrow down the events to count requiring exact match.

Returns:

List of unique values of events matching the specified filters and search.

Return type:

UniqueResultList

Examples

Get the unique metadata keys with count of events in your CDF project:

>>> from cognite.client import CogniteClient
>>> from cognite.client.data_classes.events import EventProperty
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> result = client.events.aggregate_unique_properties(EventProperty.metadata)
>>> print(result.unique)