Get time range of collection data

GET/homes/{homeId}/smartModules/{moduleId}/collections/{collectionId}/timeRange

Base URL: https://api.tinkermode.com

Get the timestamp of the first and last data entries in the specified time series collection.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a user, service account, or project API key.

Path parameters

Name	Type	Required	Constraints	Description
`homeId`	integer	Yes		The unique id for a home.
`moduleId`	string	Yes		The unique id for a smart module.
`collectionId`	string	Yes		Collection ID. It must be unique per home.

Responses

`200` The requested time range is returned.

Content type: application/json

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 (':').

Response example

{
  "begin": "2018-12-11T17:00:22Z",
  "end": "2020-01-29T01:26:08.101Z",
  "seriesId": "room1-temperature"
}

`401` Authorization is required to access this resource.

Content type: application/json

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.

`403` Request failed because of denied permission.

Content type: application/json

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.

`404` The requested timeRange does not exist or is not accessible.

Content type: application/json

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.

`429` Request failed because of rate limit.

Content type: application/json

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.

`500` An unexpected error has occurred.

Content type: application/json

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.

`503` The service is temporarily unavailable.

Content type: application/json

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.