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

  • 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.id

  • Asset Name: name

  • Asset Type: type


Handling Pagination

  1. Check the hasNext boolean field in the response.

  2. If hasNext: true, increment the page parameter by 1 (page=1, page=2, etc.) and append the new results to your lookup table until hasNext returns false.

  3. Alternatively, increase pageSize (e.g., pageSize=1000) to retrieve all assets in a single request for smaller fleets.