List

List all meters.

Lists all available meters for a specific project. Optionally filter by meter ID prefix using a Prefix filter.

Parameters:

filter (Prefix | None) – Optional Prefix filter to apply on the meterId property (only Prefix filters are supported).
limit (int | None) – Maximum number of meters to return. Defaults to 25. Set to None or -1 to return all meters.
start (int | str | datetime.datetime | None) – Start of the time range for historical data. Accepts milliseconds since epoch, a datetime object, or a relative time string like "2w-ago". Must be provided together with number_of_datapoints to get time-series data. If omitted, only meter metadata is returned without time-series data.
end (int | str | datetime.datetime | None) – End of the time range for historical data. Accepts milliseconds since epoch, a datetime object, or a relative time string like "now". Only relevant when start is provided. Defaults to the current time on the server if omitted.
number_of_datapoints (int | None) – Number of equal-width time buckets to return between start and end. Must be provided together with start to get time-series data. Valid range: 0-600. API server default is 0 (metadata only).

Returns:

List of all meters in the project.

Return type:

MeteringDataList

Examples

List all meters:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> meters = client.metering.list(limit=None)

List meters filtered by prefix (e.g., all meters for the ‘atlas’ service):

>>> from cognite.client.data_classes.filters import Prefix
>>> prefix_filter = Prefix("meter_id", "atlas.")
>>> meters = client.metering.list(filter=prefix_filter)

List meters with historical data:

>>> meters = client.metering.list(
...     start=1764547200000,
...     end=1767225599000,
...     number_of_datapoints=30,
... )