Common API Requests
Assets Lookup
To fetch or stream telemetry data for specific assets, you must first retrieve their internal platform UUIDs (id.id).
Request
HTTP Method:
GET
Header:
X-Authorization: ApiKey tb_<your_api_key>
Query Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
pageSize | Integer | Yes | Number of assets to return |
page | Integer | Yes | Page number (zero-based) |
type | String | No | Asset type/profile to filter by |
Response Structure
The endpoint returns a paginated JSON object. Parse the response payload to populate your lookup table (array of objects) with the following core properties:
Asset UUID:
id.idAsset Name:
nameAsset Type:
type
Handling Pagination
Check the
hasNextboolean field in the response.If
hasNext: true, increment thepageparameter by1(page=1,page=2, etc.) and append the new results to your lookup table untilhasNextreturnsfalse.Alternatively, increase
pageSize(e.g.,pageSize=1000) to retrieve all assets in a single request for smaller fleets.