GET HistoricalData

Returns the historical values of a point.

Relative URL

rest/HistoricalData?PointName={PointName}&StartDate={StartDate}&EndDate={EndDate}&AggregateName={AggregateName}&ProcessingInterval={ProcessingInterval}

Parameters

PointName (required) - The fully qualified name of the point for which to retrieve the value.

Default Value: None

Example Value: hh:\Configuration\Signals:SineFast

StartDate (optional) - The start time of the window for which to retrieve the data in the format: YYYY-MM-ddThh:mm:ss. The special value of 'now' (without quotes) can be used to pass the current date and time. A negative offset can also be provided using the format: now - hh:mm:ss

Default Value: 1 day back from the value of EndDate.

Example Value: 2015-01-01T00:00:00

EndDate (optional) - The end time of the window for which to retrieve the data in the format: YYYY-MM-ddThh:mm:ss. The special value of 'now' (without quotes) can be used to pass the current date and time. A negative offset can also be provided using the format: now - hh:mm:ss

Default Value: The current date and time at the moment of the call.

Example Value: 2015-01-31T00:00:00

AggregateName (optional) - When not provided, raw logged values will be returned. When providing an aggregate name processed samples will be returned. Supported aggregate names depend on the historian being queried. When used, it is also necessary to specify ProcessingInterval.

Default Value: None

Example Value: Average

ProcessingInterval (optional) - The processing interval to apply when returning aggregated data. The interval has to be provided in the following format: hh:mm:ss

Default Value: None

Example Value: 00:01:00

Example Result

An array containing multiple objects, each one representing one sample of data.

[

{

"PointName": "hh:\\Configuration\\Signals:SineFast",

"Value": 47.540079194794316,

"Timestamp": "2015-08-13T10:40:06.117-04:00",

"Quality": 0

{

"PointName": "hh:\\Configuration\\Signals:SineFast",

"Value": 54.079530578291539,

"Timestamp": "2015-08-13T10:40:06.365-04:00",

"Quality": 0

{

"PointName": "hh:\\Configuration\\Signals:SineFast",

"Value": 60.549180053570154,

"Timestamp": "2015-08-13T10:40:06.615-04:00",

"Quality": 0

}

]