GET /api/v3/channel/{channelId}/reading

Retrieves interval data readings for a specific channel within a date range

GetReadingsV3 Permissions: Meters (View)
Use this endpoint to get time-series reading data for a meter channel. If endDate is omitted, defaults to the latest reading date. If beginDate is omitted, defaults to 4 days before endDate. Returns the channel’s unit configuration along with the readings.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
channelId Unique numeric identifier of the channel integer (int32) Required

Query Parameters

Name Description Type Required
beginDate Start of the date range (inclusive). Defaults to endDate minus 4 days. string (date-time) Optional
endDate End of the date range (inclusive). Defaults to the latest reading date on the channel. string (date-time) Optional
originalValue DEPRECATED: No longer used. Previously controlled original vs computed value display. boolean Optional

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Readings
Property Description Type
channelId The Id of the Channel integer (int32)
readings Readings+Observation[]
Readings+Observation properties
Property Description Type
estimated Indicates if the reading is estimated Required (defined) boolean
note A note pertaining to the reading Required (defined) string
observationId The unique ID for the reading Required (defined) integer (int64)
rawValue The raw value of the reading (before multiplier or delta are applied) Required (defined) number (double)
time The date and time of the reading Required (defined) string (date-time)
value The raw or computed value of the reading Required (defined) number (double)
rule 1 = odometer, 2 = trip (to calculate delta) integer (int32)
unit UnitChild
UnitChild properties
Property Description Type
unitCode The unit code string
unitId The unit identifier integer (int32)
unitInfo The unit info string
Example Response application/json 
{  "channelId": 1,  "readings": [
    {    "estimated": false,    "note": "string",    "observationId": 1,    "rawValue": 1.0,    "time": "2026-06-29",    "value": 1.0
  }
  ],  "rule": 1,  "unit": {    "unitCode": "string",    "unitId": 1,    "unitInfo": "string"
  }
}
404 Not Found The requested resource was not found. Verify the ID or path is correct.