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.

Query Parameters

Name	Description	Type	Required
filter		string (string)	Optional
orderBy		string (string)	Optional

Filters

Filter	Description	Type	Operators
commodityCategoryInfo	Commodity Category Name	String	equals not equals one of like not like not one of
commodityInfo	Commodity Name	String	equals not equals one of like not like not one of
esaChannelID		Integer	one of not one of
esaDataPointCode	Data Point Code	String	one of
esaDataPointID		Integer	equals one of not one of
esaDataPointInfo	Data Point Name	String	one of
estimated	Reading is Estimated	Boolean	equals
fullName	Full Name	String	one of
intervalInfo	ESA Channel Interval	String	one of
note	Reading Note Contains	String	like
observationTypeInfo	Observation Type Name	String	equals not equals one of like not like not one of
summarizedValue	Summarized Value	Double	equals not equals less than between greater than less than equal greater than equal not between
timestamp	Timestamp	DateTimeOffset	equals not equals less than between greater than less than equal greater than equal
topmostPlaceCode	Topmost Place Code	String	equals not equals one of like not like not one of
topmostPlaceInfo	Topmost Place Name	String	equals not equals one of like not like not one of

Order By Options

Name	Description
esaChannelInfo	ESA Channel Name
observationTypeInfo	Observation Type Name
interval	Channel Interval
timestamp	Timestamp
summarizedValue	Summarized Value
unitInfo	Unit Name
esaDataPointInfo	Data Point Name
esaDataPointCode	Data Point Code

Responses

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

Response Body Parameters

Type: string (binary)

Example Response application/json Copy

"string"