Deprecated: TSDB Smart Module data models

getAllTimeSeriesCollections — 200 response

An array of time series collections are returned.

Metadata of a time series collection.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this collection belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series Collection ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this collection.
`tagNames`	array	No	read-only (server-generated)	List of unique Identifiers of string tags in collection.
`timeZone`	string	No	read-only (server-generated)	If present, collection is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.
`valueNames`	array	No	read-only (server-generated)	List of unique Identifiers of numerical fields in collection.

getAllTimeSeriesCollections — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeriesCollections — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeriesCollections — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeriesCollections — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeriesCollections — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeriesCollection — request

Request body for Create a time series collection.

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this collection belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series Collection ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this collection.
`tagNames`	array	No	read-only (server-generated)	List of unique Identifiers of string tags in collection.
`timeZone`	string	No	read-only (server-generated)	If present, collection is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.
`valueNames`	array	No	read-only (server-generated)	List of unique Identifiers of numerical fields in collection.

createTimeSeriesCollection — 201 response

Collection successfully created.

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this collection belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series Collection ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this collection.
`tagNames`	array	No	read-only (server-generated)	List of unique Identifiers of string tags in collection.
`timeZone`	string	No	read-only (server-generated)	If present, collection is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.
`valueNames`	array	No	read-only (server-generated)	List of unique Identifiers of numerical fields in collection.

createTimeSeriesCollection — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeriesCollection — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeriesCollection — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeriesCollection — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeriesCollection — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesCollection — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesCollection — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesCollection — 404 response

The required collection does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesCollection — 409 response

The collection cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesCollection — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesCollection — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesCollection — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesCollection — 200 response

Info of the requested time series collection is returned.

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this collection belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series Collection ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this collection.
`tagNames`	array	No	read-only (server-generated)	List of unique Identifiers of string tags in collection.
`timeZone`	string	No	read-only (server-generated)	If present, collection is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.
`valueNames`	array	No	read-only (server-generated)	List of unique Identifiers of numerical fields in collection.

getTimeSeriesCollection — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesCollection — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesCollection — 404 response

The requested collection does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesCollection — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesCollection — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesCollection — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteCollectionData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteCollectionData — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteCollectionData — 404 response

The required data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteCollectionData — 409 response

The data cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteCollectionData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteCollectionData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteCollectionData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCollectionData — 200 response

The requested collection data entries are returned.

Property	Type	Required	Constraints	Description
`aggregation`	string	No	read-only (server-generated); one of: avg, min, max, sum, count	Aggregation method used.
`begin`	string	No	read-only (server-generated)	The begin time of data entries. The format follows RFC3339.
`collectionId`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series Collection ID. Must be unique within each home. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`data`	array	No	read-only (server-generated)	Collection data. Each entry is an array as tuple and the first item is timestamp of the value in RFC3339 format, followed by the selected values and tags. e.g. [["2016-01-01T00:00:00Z", 1.0, 333, "foo"], ["2016-01-02T00:00:00Z", 2.0, 299, "bar"]]
`end`	string	No	read-only (server-generated)	The end time of data entries. The format follows RFC3339.
`limit`	integer	No	read-only (server-generated)	The maximum number of data entries to be fetched.
`resolution`	string	No	read-only (server-generated); one of: 1min, 10min, 1hour, 1day, 1week, 1month	Aggregation bucket resolution. Its value depends on the time span of the query.
`ts`	string	No	read-only (server-generated)	The point in time (in RFC3339) from which data entries were fetched.

getCollectionData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCollectionData — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCollectionData — 404 response

The requested data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCollectionData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCollectionData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCollectionData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeRangeCollectionData — 200 response

The requested time range is returned.

Property	Type	Required	Constraints	Description
`begin`	string	No	read-only (server-generated)	The beginning timestamp of the time series. The format follows RFC3339.
`collectionId`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Collection ID. Present if time range belongs to a Time Series Collection. Must be unique within each home. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`end`	string	No	read-only (server-generated)	The ending timestamp of the time series. The format follows RFC3339.
`seriesId`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series ID. Present if time range belongs to a Simple Time Series. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':').

getTimeRangeCollectionData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeRangeCollectionData — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeRangeCollectionData — 404 response

The requested timeRange does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeRangeCollectionData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeRangeCollectionData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeRangeCollectionData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportTimeSeriesData — request

Request body for Export time series data.

Property	Type	Required	Constraints	Description
`begin`	string	Yes	read-only (server-generated); format: date-time	The beginning timestamp of the export time range (in RFC3339).
`collectionIds`	array	No	read-only (server-generated)	Array of collection IDs whose data are to be exported.
`end`	string	Yes	read-only (server-generated); format: data-time	The ending timestamp of the export time range (in RFC3339).
`fileNames`	array	No	read-only (server-generated)	Optional field to specify export file names. It should correspond to seriesIds/collectionIds in number and order. If omitted, series or collection IDs will be used in the file names.
`includeHeader`	boolean	No	read-only (server-generated)	If true, each exported CSV file will start with a header. Used only when exporting collections.
`seriesIds`	array	No	read-only (server-generated)	Array of series IDs whose data are to be exported.
`timeFormat`	string	No	read-only (server-generated)	Optional parameter to specify the timestamp format in the exported CSV. Use "rfc3339Milli" for RFC3339 format with millisecond precision. If omitted, the default format (YYYY/MM/DD HH:MM:SS) is used.

exportTimeSeriesData — 200 response

The URLs for downloading the exported data are returned.

Property	Type	Required	Constraints	Description
`dataUrl`	string	Yes	read-only (server-generated)	URL of file containing the exported data. This URL is usable only if the export is completed successfully.
`statusUrl`	string	Yes	read-only (server-generated)	URL to a JSON file that reports the status of the export. Clients should poll this URL until a file is returned.

exportTimeSeriesData — 403 response

Request failed because of invalid request parameters.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportTimeSeriesData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportTimeSeriesData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllIncidentsHome — 200 response

An array of monitors are returned.

Incident that is created by monitor

An array of objects with the following shape:

Property Type Required Constraints Description

creationTime string No read-only (server-generated) Timestamp of creation of this incident.

description string No read-only (server-generated) Description of this incident

evaluationTimeRange unknown No

homeId integer No read-only (server-generated) Home that this monitor belongs to

incidentType string No read-only (server-generated); one of: alert, recovery Type of this incident

moduleId string No read-only (server-generated) Smart Module that this incident belongs to

monitorId integer No read-only (server-generated) Monitor that created this incident

monitorSnapshot object No Snapshot of the monitor which is to be created when the incident is created

Property Type Required Constraints Description

condition one of 2 No read-only (server-generated) Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No Monitor description

evaluationDelay integer No read-only (server-generated) How long the monitor evaluation should be delayed

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

name string No Monitor name

projectId integer No read-only (server-generated) Project that this incident belongs to

getAllIncidentsHome — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllIncidentsHome — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllIncidentsHome — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllIncidentsHome — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllIncidentsHome — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllMonitorsHome — 200 response

An array of monitors are returned.

You will get this object when you retrieve monitors in your Home

An array of objects with the following shape:

Property Type Required Constraints Description

condition one of 2 No read-only (server-generated) Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No read-only (server-generated) Monitor description

enabled boolean No read-only (server-generated) Whether this monitor is enabled

evaluationDelay integer No read-only (server-generated); min: 0 How long the monitor evaluation should be delayed

homeId integer No read-only (server-generated) Home that this monitor belongs to

id integer No read-only (server-generated) Identifier of monitor

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

isAlerting boolean No read-only (server-generated) If true, some or all of the monitoring targets are in alert state

issue string No read-only (server-generated) issue of monitor setting

modificationTime string No read-only (server-generated); format: date-time Timestamp of modification.

moduleId string No read-only (server-generated) Smart Module that this monitor belongs to

name string No read-only (server-generated) Monitor name

projectId integer No read-only (server-generated) Project that this monitor belongs to

getAllMonitorsHome — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllMonitorsHome — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllMonitorsHome — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllMonitorsHome — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllMonitorsHome — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createMonitorHome — request

Request body for Create a monitor for a home.

Property Type Required Constraints Description

condition one of 2 No read-only (server-generated) Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No read-only (server-generated) Monitor description

enabled boolean No read-only (server-generated) Whether this monitor is enabled

evaluationDelay integer No read-only (server-generated); min: 0 How long the monitor evaluation should be delayed

homeId integer No read-only (server-generated) Home that this monitor belongs to

id integer No read-only (server-generated) Identifier of monitor

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

isAlerting boolean No read-only (server-generated) If true, some or all of the monitoring targets are in alert state

issue string No read-only (server-generated) issue of monitor setting

modificationTime string No read-only (server-generated); format: date-time Timestamp of modification.

moduleId string No read-only (server-generated) Smart Module that this monitor belongs to

name string No read-only (server-generated) Monitor name

projectId integer No read-only (server-generated) Project that this monitor belongs to

createMonitorHome — 201 response

Monitor successfully created

Property Type Required Constraints Description

condition one of 2 No read-only (server-generated) Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No read-only (server-generated) Monitor description

enabled boolean No read-only (server-generated) Whether this monitor is enabled

evaluationDelay integer No read-only (server-generated); min: 0 How long the monitor evaluation should be delayed

homeId integer No read-only (server-generated) Home that this monitor belongs to

id integer No read-only (server-generated) Identifier of monitor

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

isAlerting boolean No read-only (server-generated) If true, some or all of the monitoring targets are in alert state

issue string No read-only (server-generated) issue of monitor setting

modificationTime string No read-only (server-generated); format: date-time Timestamp of modification.

moduleId string No read-only (server-generated) Smart Module that this monitor belongs to

name string No read-only (server-generated) Monitor name

projectId integer No read-only (server-generated) Project that this monitor belongs to

createMonitorHome — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createMonitorHome — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createMonitorHome — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createMonitorHome — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createMonitorHome — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMonitorHome — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMonitorHome — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMonitorHome — 404 response

The required monitor does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMonitorHome — 409 response

The monitor cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMonitorHome — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMonitorHome — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMonitorHome — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMonitorHome — 200 response

Info of the requested monitor is returned.

Property Type Required Constraints Description

condition one of 2 No read-only (server-generated) Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No read-only (server-generated) Monitor description

enabled boolean No read-only (server-generated) Whether this monitor is enabled

evaluationDelay integer No read-only (server-generated); min: 0 How long the monitor evaluation should be delayed

homeId integer No read-only (server-generated) Home that this monitor belongs to

id integer No read-only (server-generated) Identifier of monitor

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

isAlerting boolean No read-only (server-generated) If true, some or all of the monitoring targets are in alert state

issue string No read-only (server-generated) issue of monitor setting

modificationTime string No read-only (server-generated); format: date-time Timestamp of modification.

moduleId string No read-only (server-generated) Smart Module that this monitor belongs to

name string No read-only (server-generated) Monitor name

projectId integer No read-only (server-generated) Project that this monitor belongs to

getMonitorHome — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMonitorHome — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMonitorHome — 404 response

The requested monitor does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMonitorHome — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMonitorHome — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMonitorHome — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMonitorHome — request

Request body for Update a monitor for a home.

Property Type Required Constraints Description

condition one of 2 No Monitor Condition object

One of the following 2 shapes:

Variant 1

Heartbeat monitoring condition against data points in a time series.

Property	Type	Required	Description
`conditionType`	string	Yes	Currently, the only supported type is `timeSeriesHeartbeat`.
`interval`	integer	Yes	Duration of time (second) how often data points are expected to appear in the time series. It should be longer than 60 seconds at least.
`seriesId`	string	Yes	Time Series ID to be monitored.

Variant 2

Threshold-based monitoring condition against static data points in a time series

Property	Type	Required	Constraints	Description
`conditionType`	string	Yes		Currently, the only supported type is `timeSeriesThreshold`
`dataPointsDuration`	integer	Yes		Expected duration of time (in seconds) between two data points
`dataPointsEvaluationPolicy`	string	Yes	one of: consecutive, total	How to count the breaching data points
`interval`	integer	Yes		How often (in seconds) the monitoring condition is evaluated
`missingDataPointPolicy`	string	Yes	one of: ignore, breaching, notBreaching	How to treat missing data
`numberOfBreachingDataPointsToAlert`	integer	Yes		Number of breaching data points before an alert is triggered
`operator`	string	Yes	one of: lessThan, lessThanOrEqualTo, equal, notEqual, greaterThanOrEqualTo, greaterThan	The operator to compare the threshold value and monitored value
`seriesId`	string	Yes		Time Series ID to be monitored
`threshold`	number	Yes		Threshold value against which the monitor evaluates whether the data point has breached the condition

description string No Monitor description

enabled boolean No Whether this monitor is enabled

evaluationDelay integer No min: 0 How long the monitor evaluation should be delayed; if this field is omitted when monitor is created, default value 0 will be applied

incidentCustomDescriptions object No User defined incident descriptions

Properties of incidentCustomDescriptions
Property	Type	Required	Constraints	Description
`alert`	string	No	read-only (server-generated)	Custom description for alert incident. If not set, default description will be 'ALERT: ${monitor.name}'
`recovery`	string	No	read-only (server-generated)	Custom description for recovery incident. If not set, default description will be 'RECOVERY: ${monitor.name}'

name string No Monitor name

updateMonitorHome — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMonitorHome — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMonitorHome — 404 response

The requested monitor does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMonitorHome — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMonitorHome — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMonitorHome — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeries — 200 response

An array of time series objects are returned.

Metadata of a simple time series associated with a home.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this time series belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this time series.
`timeZone`	string	No	read-only (server-generated)	If present, time series is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.

getAllTimeSeries — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeries — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeries — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeries — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAllTimeSeries — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeries — request

Request body for Create a time series.

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this time series belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this time series.
`timeZone`	string	No	read-only (server-generated)	If present, time series is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.

createTimeSeries — 201 response

Time series successfully created.

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this time series belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this time series.
`timeZone`	string	No	read-only (server-generated)	If present, time series is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.

createTimeSeries — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeries — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeries — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeries — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createTimeSeries — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeries — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeries — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeries — 404 response

The required timeSery does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeries — 409 response

The timeSery cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeries — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeries — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeries — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeries — 200 response

The requested time series object is returned.

Property	Type	Required	Constraints	Description
`homeId`	integer	No	read-only (server-generated)	Home that this time series belongs to.
`id`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series ID. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`moduleId`	string	No	read-only (server-generated)	ID of Smart Module that created this time series.
`timeZone`	string	No	read-only (server-generated)	If present, time series is associated with a time zone that is not UTC. This should be a time zone name defined in the IANA TZ Database.

getTimeSeries — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeries — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeries — 404 response

The requested timeSery does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeries — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeries — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeries — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesData — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesData — 404 response

The required data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesData — 409 response

The data cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteTimeSeriesData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesData — 200 response

The requested time series data points are returned.

Property	Type	Required	Constraints	Description
`aggregation`	string	No	read-only (server-generated); one of: avg, min, max, sum, count	Aggregation method used.
`begin`	string	No	read-only (server-generated)	The beginning of the time series data. The format follows RFC3339.
`data`	array	No	read-only (server-generated)	Time series data. Each item is an array as tuple and the first item is timestamp of the value in RFC3339 format and the second is the value.
`end`	string	No	read-only (server-generated)	The end of the time series data. The format follows RFC3339.
`limit`	integer	No	read-only (server-generated)	The maximum number of data points to be fetched.
`resolution`	string	No	read-only (server-generated); one of: 1min, 10min, 1hour, 1day, 1week, 1month	Aggregation bucket resolution. Its value depends on the time span of the query.
`seriesId`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series ID. Must be unique within each home. Must be 1 or more alphanumeric characters; dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`ts`	string	No	read-only (server-generated)	The point in time (in RFC3339) from which data points were fetched.

getTimeSeriesData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesData — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesData — 404 response

The requested data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesTimeRange — 200 response

The requested time range is returned.

Property	Type	Required	Constraints	Description
`begin`	string	No	read-only (server-generated)	The beginning timestamp of the time series. The format follows RFC3339.
`collectionId`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Collection ID. Present if time range belongs to a Time Series Collection. Must be unique within each home. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
`end`	string	No	read-only (server-generated)	The ending timestamp of the time series. The format follows RFC3339.
`seriesId`	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:][a-zA-Z0-9])$	Time Series ID. Present if time range belongs to a Simple Time Series. Must be unique within each home. Must be 1 or more alphanumeric characters and may contain dashes ('-'), underscores ('_'), and colons (':').

getTimeSeriesTimeRange — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesTimeRange — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesTimeRange — 404 response

The requested timeRange does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesTimeRange — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesTimeRange — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getTimeSeriesTimeRange — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.