smartMeterTelemetry

Query telemetry data collected by the CAD associated with the provided ESME or GSME device ID.

If only the smart meter device ID is provided, the latest data available will be returned.

Additionally including the range options (start, end, and grouping) will return the data for that time period, at the desired granularity.

Arguments

deviceId : String!


            required

The ESME or GSME's EUI64 ID, e.g. '12-34-5A-FF-FF-6B-C7-89'

end : DateTime

The end time of the range of readings (exclusive), e.g. '2022-01-28T16:34:42+00:00'. If no UTC timezone offset is included, UTC (+00:00) will be assumed.

grouping : TelemetryGrouping

The granularity of the returned data. The representative data item (e.g. consumption) for each group (e.g. every 5 minutes) will be the mean value over that period.

start : DateTime

The start time of the range of readings (inclusive), e.g. '2022-01-28T16:33:22+00:00'. If no UTC timezone offset is included, UTC (+00:00) will be assumed.

Returns

[SmartMeterTelemetryType]

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can view detailed usage

Rate Limits

Key	Steps
`user`	['125/h']

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 SmartMeterTelemetry(
  $deviceId: String!,
  $end: DateTime,
  $grouping: TelemetryGrouping,
  $start: DateTime
) {
  smartMeterTelemetry(
    deviceId: $deviceId,
    end: $end,
    grouping: $grouping,
    start: $start
  ) {
    consumption
    consumptionDelta
    costDelta
    costDeltaWithTax
    demand
    export
    readAt
  }
}

{
  "deviceId": "35759942",
  "end": "2007-07-08T04:14:31.255350+00:00",
  "grouping": "TEN_SECONDS",
  "start": "1992-01-19T17:55:47.836951+00:00"
}

{
  "data": {
    "smartMeterTelemetry": [
      {
        "consumption": "1.0",
        "consumptionDelta": "1.0",
        "costDelta": "1.0",
        "costDeltaWithTax": "1.0",
        "demand": "1.0",
        "export": "1.0",
        "readAt": "2005-09-15T19:39:17.336227+00:00"
      }
    ]
  }
}