Retrieve multiple consumption data by their ids

Required capabilities: projectsAcl:LIST

Retrieves multiple consumption data items by their IDs.

  • 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
header Parameters
cdf-version
required
string
Value: "20230101-alpha"
Request Body schema: application/json
required
required
Array of objects non-empty

List of metering IDs to retrieve.

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

The requested consumption data. 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/byids
Request samples
application/json
{
  • "items": [
    • {
      },
    • {
      }
    ]
}
Response samples
application/json
{
  • "items": [
    • {
      },
    • {
      }
    ]
}
➔ Next to PostgreSQL Gateway / Postgres Gateway Users