GET /api/v3/widget/intervaldata/{specificWidgetId}

Retrieves interval data (readings) for a specific interval data widget.

GetIntervalDataV3 Permissions: LicenseFeatureIntervalDataAnalysis (View)

Use this endpoint to get time-series readings for a channel or ESA meter. Does NOT support global dashboard filtering with Topmost Place or Place Group API filters. Requires a Days Prior filter and exactly one channel/meter selection filter. Optionally includes a comparison week for period-over-period analysis. Requires IntervalDataAnalysis View permission.

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
specificWidgetId	Unique numeric identifier of the specific Interval Data widget instance	integer (int32)	Required

Responses

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

Response Body Parameters

Array of:

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"
    }
  }
]