Filter meters

Required capabilities: projectsAcl:LIST

Lists meter IDs using a filter.

  • Without start and numberOfDatapoints: Returns meter metadata.
  • With start and numberOfDatapoints: Returns historical time-series data with averaged values.

Only the prefix filter operator is supported.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
header Parameters
cdf-version
required
string
Value: "20230101-alpha"
Request Body schema: application/json
object

Filter to apply to the list operation. To retrieve all metering values for a specific service, use the "prefix" operator where the property is the metering's key, e.g., {"prefix": {"property": ["meterId"], "value": "atlas."}}

limit
integer <= 1000
Default: 1000

Maximum number of items to return.

cursor
string

Cursor to use for paging through results.

start
string <date-time>

Start timestamp (inclusive) for historical data. When provided along with end and 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.

Responses
200

Filtered 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.

post/metering/meters/list
Request samples
application/json
{
  • "filter": {
    • "prefix": {
      }
    },
  • "limit": 1000,
  • "cursor": "string"
}
Response samples
application/json
{
  • "items": [
    • {
      },
    • {
      }
    ],
  • "nextCursor": "eyJjdXJzb3IiOiAiMTIzNDU2In0="
}
➔ Next to List all meters