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
Optional meter device identifier to filter readings.
The end of the requested period (exclusive, timezone-aware).
The market this supply point belongs to.
The reading type to estimate. PEAK is not supported.
Optional register identifier to filter readings.
The start of the requested period (inclusive, timezone-aware).
The market-level external identifier of the supply point (e.g. ICP number).
The time granularity for aggregating readings.
IANA timezone name used for aggregation boundaries (e.g. 'Pacific/Auckland').
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-13605: No estimation algorithm configured for the requested parameters.
- KT-CT-13610: Supply point not found or not configured for estimation.
- KT-CT-13611: No readings found for the requested period.
- KT-CT-13612: PEAK reading type is not supported for estimation.
- KT-CT-13613: Market not configured for supply point readings.
- KT-CT-13614: Invalid timezone.
- KT-CT-13615: No readings available for estimation.
- KT-CT-13616: Meter readings are invalid.
- KT-CT-13617: Unsupported time granularity for estimation.
- KT-CT-13618: Register metadata not found for supply point.
- KT-CT-13619: Multiple register metadata records found for supply point.
- KT-CT-7899: An internal error occurred.
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
}
}
Variables
{
"deviceId": "68772277",
"endAt": "2023-03-24T15:22:28.091220+00:00",
"marketName": "need-generation-quality-set-weight",
"readingType": "INTERVAL",
"registerId": "12884299",
"startAt": "1993-08-02T20:57:09.422116+00:00",
"supplyPointId": "84686034",
"timeGranularity": "FIVE_MIN",
"timezone": "two-beyond-picture-rich-fast"
}
Response
{
"data": {
"estimatedSupplyPointReadings": [
{
"intervalEnd": "2012-02-13T01:02:41.553029+00:00",
"intervalStart": "2020-10-03T07:11:07.806554+00:00",
"isEstimated": true,
"quality": "wind-may-whose-medical-travel",
"value": "1.0"
}
]
}
}