Get Thermostat Interval Data

Returns individual Thermostat runtime data aggregated to the specific granularity requested for a specified start and end date.

See Interval Data Overview for broader context on interval data endpoints.

Path Params
string
required

ID of the Thermostat to query

Query Params
string
enum

Interval data is available summarized to month, day, hour, 15mins.

Allowed:
string

The earliest date for which data should be returned. It cannot be earlier than the operationalSince value for the corresponding Site. See the interval data overview for details about the defaulting behavior when this parameter is not provided.

If provided, it's recommended that start date align with the requested summary level; otherwise, it will be rounded up to the next appropriate interval boundary. For example, a request with a summary level of day and a start date of 2025-08-01T23:59:00Z will return data beginning 2025-08-02T00:00:00Z.

The value can be an RFC3339 timestamp, an unambiguous prefix of a RFC3339 timestamp (if offset omitted, UTC is assumed), seconds since unix epoch, or milliseconds since unix epoch.

The value is treated as inclusive, meaning that data for the specified start date is included in the response.

string

The latest date for which data should be returned. It cannot be later than now. See the interval data overview for details about the defaulting behavior when this parameter is not provided.

If provided, it's recommended that end date align with the requested summary level; otherwise, it will be rounded down to the next appropriate interval boundary. For example, a request with a summary level of day and an end date of 2025-09-01T00:01:00Z will return data beginning 2025-09-01T00:00:00Z.

The value can be an RFC3339 timestamp, an unambiguous prefix of a RFC3339 timestamp (if offset omitted, UTC is assumed), seconds since unix epoch, or milliseconds since unix epoch.

The value is treated as exclusive, meaning that data up until (but not through) the specified end is included in the response; i.e., this models a standard right-open interval.

string
enum
Defaults to include

How to handle missing interval data.

By default, intervals with missing data will be included and explicitly marked missing.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json