List all meters

Required capabilities: projectsAcl:LIST

Lists all available meter IDs for a specific project.

  • Without start and numberOfDatapoints: Returns meter metadata.
  • With start and numberOfDatapoints: Returns historical time-series data with averaged values.
Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
cursor
string

Cursor to use for paging through results.

limit
integer <int32> <= 1000
Default: 1000

Return up to this many results.

start
string <date-time>

Start timestamp (inclusive) for historical data. When provided along with numberOfDatapoints, returns time-series data. If not provided, only the meter metadata is returned.

end
string <date-time>

End timestamp (inclusive) for historical data. Defaults to the current time if not provided.

numberOfDatapoints
integer <int32> [ 0 .. 600 ]
Default: 0

Number of data points to return between start and end. The time range is divided into equal periods to match the number of datapoints requested. If not provided, only the meter metadata is returned.

header Parameters
cdf-version
required
string
Value: "20230101-alpha"
Responses
200

A list of meters. Returns meter metadata unless 'start' and 'numberOfDataPoints' are provided. When they are provided, includes historical time-series data with averaged values.

401

The response for a failed request.

get/metering/meters
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      },
    • {
      },
    • {
      }
    ],
  • "nextCursor": "string"
}
➔ Next to Retrieve consumption data by its id