How Can We Help?
Print

ThermostatHistory

ThermostatHistory attributes allows you to retrieve thermostat historical readings and setpoint information.

ThermostatHistory request must include at least the required selection attributes, which specify a starting date/time (startDateTime) and an ending date/time (endDateTime). If you do not specify any ThermostatHistory object attributes in the request, so only the date range is part of the request, then all ThermostatHistory object attribute historical information will be returned for every thermostat part of the site within the specified date range.

ThermostatHistory - Selection Attributes

Name Values Required Description
startDateTime Date/Time Yes ISO 8601 Formatted Date Time. Used for selecting the history date range to retrieve.
endDateTime Date/Time Yes ISO 8601 Formatted Date Time. Used for selecting the history date range to retrieve. A maximum of 30 days of history can be retrieved in a single request.
name String No The configured name of the thermostat.
groupName​ String​ No The configured group name for that thermostat.
serialNo String​ No The thermostat's serial number. Unique factory set identifier.

ThermostatHistory - Object Attributes

Attribute names are not case sensitive. Attribute values are case sensitive. Because this is historical information, all requests are GET only.

Name Values Description
name String The configured name of the thermostat.
groupName String The configured group name for that thermostat.
serialNo String The thermostat's serial number. Unique factory set identifier.
system Off, Auto, Heat, Cool The active thermostat's system mode
heatSetting Integer The thermostat's active Heat Setting.
coolSetting Integer The thermostat's active Cool Setting.
fan Auto, On The thermostat's active Fan Mode.
status Occupied, Vacant Normally Occupied. Vacant when vacation schedule is active.
temperature Decimal The thermostat's current measured temperature.
humidity Integer The thermostat's current measured humidity: % RH. Zero (0) if humidity is not supported.
humidifySetting Integer The thermostat's minimum humidity setting.
dehumidifySetting Integer The thermostat's maximum humidity setting.
co2Setting Integer The thermostat's demand ventilation CO2 setting.
co2Level Integer The thermostat's current measured CO2 level.
setBy Station, Remote, Schedule Indicates how the active thermostat settings were set.
frontKeypad On, Off Thermostat keypad active or locked status. On = Unlocked, Off = Locked.
runStatus Off, Cool-Stage1, Cool-Stage2, Heat-Stage1, Heat-Stage2, Fan, Fan2 The currently active Fan, Heat or Cool status
auxStatus On, Off The thermostat's active Auxiliary Heat status.
slaves Array List of the remote temperature sensors and devices assigned to this thermostat and their values.
setback On, Off Whether a temporary Demand Response setback was active.
timestamp Date/Time ISO 8601 Formatted Date Time.