estimatedSupplyPointReadings

Return actual readings within the requested period followed by forward-estimated readings up to end_at. Estimated readings are extrapolated from the most recent actual reading.

Arguments

deviceId : ID

Optional meter device identifier to filter readings.

endAt : DateTime!


            required

The end of the requested period (exclusive, timezone-aware).

marketName : String!


            required

The market this supply point belongs to.

readingType : ReadingTypes!


            required

The reading type to estimate. PEAK is not supported.

registerId : ID

Optional register identifier to filter readings.

startAt : DateTime!


            required

The start of the requested period (inclusive, timezone-aware).

supplyPointId : String!


            required

The market-level external identifier of the supply point (e.g. ICP number).

timeGranularity : TimeGranularities!


            required

The time granularity for aggregating readings.

timezone : String!


            required

IANA timezone name used for aggregation boundaries (e.g. 'Pacific/Auckland').

Returns

[EstimatedSupplyPointReadingType]

A single reading interval for a supply point, either actual or estimated.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can estimate meter readings

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query EstimatedSupplyPointReadings(
  $deviceId: ID,
  $endAt: DateTime!,
  $marketName: String!,
  $readingType: ReadingTypes!,
  $registerId: ID,
  $startAt: DateTime!,
  $supplyPointId: String!,
  $timeGranularity: TimeGranularities!,
  $timezone: String!
) {
  estimatedSupplyPointReadings(
    deviceId: $deviceId,
    endAt: $endAt,
    marketName: $marketName,
    readingType: $readingType,
    registerId: $registerId,
    startAt: $startAt,
    supplyPointId: $supplyPointId,
    timeGranularity: $timeGranularity,
    timezone: $timezone
  ) {
    intervalEnd
    intervalStart
    isEstimated
    quality
    value
  }
}

{
  "deviceId": "32614765",
  "endAt": "2020-08-24T11:29:29.523562+00:00",
  "marketName": "himself-behavior-day-us-anything",
  "readingType": "INTERVAL",
  "registerId": "51000325",
  "startAt": "1972-04-09T23:47:29.712008+00:00",
  "supplyPointId": "24604218",
  "timeGranularity": "FIVE_MIN",
  "timezone": "what-personal-food-TV-general"
}

{
  "data": {
    "estimatedSupplyPointReadings": [
      {
        "intervalEnd": "2005-05-14T00:45:45.155862+00:00",
        "intervalStart": "1999-05-19T06:25:44.952149+00:00",
        "isEstimated": true,
        "quality": "visit-drive-base-friend-present",
        "value": "1.0"
      }
    ]
  }
}