Get Telemetry

get

https://developer-api.customer.mygridshare.com/api/v2/devices/{synthId}/telemetry

Get time-bucketed telemetry for a single device sensor stream.

synthId must be a sensor ID from the Site Topology endpoint — any node with "kind": "sensor". On most installations the telemetry streams are keyed by derived sensor IDs (e.g. <deviceId>__GRID_METER_DERIVED, <deviceId>__bb_agg, <deviceId>__PV_DERIVED). Querying the bare device ID returns an empty entries array for those installations.

Energy fields

energy_Wh_increment and energy_Wh_decrement are only populated when include=energy (or include=default,energy) is requested:

energy_Wh_increment — total energy flowing into the device (positive, lifetime cumulative).
energy_Wh_decrement — total energy flowing out of the device (negative, lifetime cumulative).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

synthId

string

required

Sensor ID from the site topology (any node where kind is "sensor").

Query Params

interval

string

required

ISO 8601 time interval. Two forms are accepted:

Start/end: 2026-04-01T00:00:00Z/2026-04-02T00:00:00Z
Start + duration: 2026-04-01T00:00:00Z/PT24H

Times must be UTC.

resolution

string

enum

Defaults to PT15M

Time resolution of the returned data in ISO 8601 duration format.

Allowed:

include

string

enum

Comma-separated list of field groups to include.

default — standard measurement fields such as power_W, soc_percent, state.
energy — cumulative energy fields (energy_Wh_increment, energy_Wh_decrement).

Defaults to default.

Allowed:

aggregation

string

enum

Defaults to default

default returns the time-window average per bucket. latest returns the most recent value recorded within each bucket (useful for near-real-time dashboards).

Allowed:

Responses

200200 response

401401 response

403403 response

404404 response