Get time series collection

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

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

Get the information of a specific 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` Info of the requested time series collection is returned.

Content type: application/json

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.

Response example

{
  "homeId": 2233,
  "id": "room1-metrics",
  "moduleId": "sensor_data",
  "tagNames": [
    "vendor_id",
    "occupant"
  ],
  "timeZone": "Europe/Berlin",
  "valueNames": [
    "temperature",
    "humidity",
    "pressure"
  ]
}

`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 collection 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.