REST API

Retrieve latest or historical time-series data for a specific asset.

Prerequisites

Before fetching telemetry via the REST API, ensure you have:

REST API telemetry requests must be executed one asset at a time using individual Asset UUIDs. To poll multiple assets, iterate through your lookup table and send separate HTTP requests for each UUID.


Request Telemetry Data

  • Header: X-Authorization: ApiKey tb_<your_api_key>


Query Parameters

Parameter

Type

Required

Description

keys

String

No

Comma-separated telemetry keys. If omitted, returns all telemetry keys. Refer to Direct Software Integration for telemetry keys.

startTs

Long

No

Start timestamp in Unix milliseconds (for historical ranges).

endTs

Long

No

End timestamp in Unix milliseconds (for historical ranges).

limit

Integer

No

Maximum number of data points to return per key


Get Latest Telemetry: No Query Parameters (limit not applicable)

Get Historical Telemetry: Requires keys, startTs, and endTs. (limit is optional, defaulting to 100).