Skip to content

Time Series

The Time Series endpoints are used for sending or receiving telemetry data. Once a Capability twin has been created that represents the time series, the telemetry associated with that twin can be created using either the twin's dtId (aka twinId) or externalId, a timestamp, and a value. Data is transmitted as an array so time series data can be batched and sent within a single request. Similarly, time series can be retreived for one or more Capability twins at a time using the twinId(s).

Insert time series values

Request

Security
oauth2
Bodyapplication/jsonrequired
Array [
connectorIdstringrequired

Id of the connector

dtIdnull or string

Id of the twin

externalIdnull or string

External Id of the twin

sourceTimestampstring, (date-time)required

Timestamp when the source recorded the value in ISO 8601 format

scalarValuenumber or anyrequired
Any of:

The data value being trended

number (double)
propertiesobject

Properties or metadata about the observation or event being trended.

]
[ { "connectorId": "TW-CC-01", "twinId": "TW-DD-II-01", "externalId": "PNTC4Jm8vXy7bWq9rT5sHkLz2p", "sourceTimestamp": "2024-10-01T12:34:56Z", "scalarValue": 42, "properties": { … } } ]

Responses

Accepted

Response
No content