supplyPointTimeOfUseReadings
Return usage within the requested period, per device and register, bucketed into calendar periods and split by time-of-use band according to the named time-of-use scheme. Each reading is assigned to the band that is active at the start of its interval, then summed into the calendar period (of the requested time granularity, in the requested timezone) containing that instant. Readings that match no band are reported under the 'UNCOVERED' band. Periods that contain no readings are omitted from the result.
Arguments
The end of the requested period (exclusive, timezone-aware).
The market-level external identifier of the supply point (e.g. ICP number).
The market this supply point belongs to.
The reading type to group. PEAK is not supported.
The start of the requested period (inclusive, timezone-aware).
The time granularity to bucket usage into within each time-of-use band.
The name of the time-of-use scheme used to group the readings.
IANA timezone name used for aggregation boundaries (e.g. 'Pacific/Auckland').
Returns
TimeOfUseReadingsType- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-15501: Time-of-use scheme not found.
- KT-CT-15502: Peak reading type is not supported.
- KT-CT-15503: Invalid timezone.
- KT-CT-15504: Overlapping time-of-use activation rules.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-4723: Invalid market name provided.
- KT-CT-7899: An internal error occurred.
Examples
query SupplyPointTimeOfUseReadings(
$endAt: DateTime!,
$externalIdentifier: String!,
$marketName: String!,
$readingType: ReadingTypes!,
$startAt: DateTime!,
$timeGranularity: TimeGranularities!,
$timeOfUseSchemeName: String!,
$timezone: String!
) {
supplyPointTimeOfUseReadings(
endAt: $endAt,
externalIdentifier: $externalIdentifier,
marketName: $marketName,
readingType: $readingType,
startAt: $startAt,
timeGranularity: $timeGranularity,
timeOfUseSchemeName: $timeOfUseSchemeName,
timezone: $timezone
) {
devices {
...TimeOfUseDevicesConnectionFragment
}
timeGranularity
}
}
Variables
{
"endAt": "1975-12-06T02:01:13.455885+00:00",
"externalIdentifier": "87055698",
"marketName": "all-kid-gas-easy-tonight",
"readingType": "INTERVAL",
"startAt": "2004-05-27T23:30:22.628328+00:00",
"timeGranularity": "FIVE_MIN",
"timeOfUseSchemeName": "place-side-bed-responsibility-back",
"timezone": "environmental-sea-direction-Democrat-generation"
}
Response
{
"data": {
"supplyPointTimeOfUseReadings": {
"devices": TimeOfUseDevicesConnection,
"timeGranularity": "FIVE_MIN"
}
}
}