Telemetry

Stream live telemetry from devices, query historical data over time ranges, and fetch the latest reading for any metric.

Access via app.telemetry.

API

stream()

Subscribe to live telemetry from a device.

JavaScript

app.telemetry.stream(params)

Python

await app.telemetry.stream(params)

Parameter	Type	Description
device_ident	string	The device identifier
metric	string[] or "*"	Metrics to subscribe to. Use "*" for all metrics
callback	function	Called with each incoming reading

JavaScript

// subscribe to specific metrics
app.telemetry.stream({
  device_ident: "sensor_01",
  metric: ["temperature", "humidity"],
  callback: (data) => {
    console.log(`${data.metric}:`, data.data);
  },
});

// subscribe to all metrics
app.telemetry.stream({
  device_ident: "sensor_01",
  metric: "*",
  callback: (data) => {
    console.log(`${data.metric}:`, data.data);
  },
});

Python

# subscribe to specific metrics
await app.telemetry.stream({
    "device_ident": "sensor_01",
    "metric": ["temperature", "humidity"],
    "callback": lambda data: print(f"{data['metric']}: {data['data']}"),
})

# subscribe to all metrics
await app.telemetry.stream({
    "device_ident": "sensor_01",
    "metric": "*",
    "callback": lambda data: print(f"{data['metric']}: {data['data']}"),
})

off()

Unsubscribe from live telemetry.

JavaScript

app.telemetry.off(params)

Python

await app.telemetry.off(params)

Parameter	Type	Description
device_ident	string	The device identifier
metric	string[]	(optional) Specific metrics to unsubscribe. Omit to unsubscribe all

JavaScript

// unsubscribe from specific metrics
app.telemetry.off({
  device_ident: "sensor_01",
  metric: ["temperature"],
});

// unsubscribe from all metrics for a device
app.telemetry.off({
  device_ident: "sensor_01",
});

Python

# unsubscribe from specific metrics
await app.telemetry.off({
    "device_ident": "sensor_01",
    "metric": ["temperature"],
})

# unsubscribe from all metrics for a device
await app.telemetry.off({
    "device_ident": "sensor_01",
})

history()

Query historical telemetry data over a time range.

JavaScript

await app.telemetry.history(params)

Python

await app.telemetry.history(params)

Parameter	Type	Description
device_ident	string	The device identifier
fields	string[]	Metrics to query
start	string	Start time (ISO 8601)
end	string	End time (ISO 8601)

Returns an object keyed by metric name, each containing an array of data points

JavaScript

const history = await app.telemetry.history({
  device_ident: "sensor_01",
  fields: ["temperature", "humidity"],
  start: "2026-03-01T00:00:00.000Z",
  end: "2026-03-02T00:00:00.000Z",
});

// history.temperature = [{ value: 22.5, timestamp: ... }, ...]
// history.humidity = [{ value: 61.3, timestamp: ... }, ...]
history.temperature.forEach((point) => {
  console.log(`${point.value} at ${point.timestamp}`);
});

Python

history = await app.telemetry.history({
    "device_ident": "sensor_01",
    "fields": ["temperature", "humidity"],
    "start": "2026-03-01T00:00:00.000Z",
    "end": "2026-03-02T00:00:00.000Z",
})

# history["temperature"] = [{"value": 22.5, "timestamp": ...}, ...]
for point in history["temperature"]:
    print(f"{point['value']} at {point['timestamp']}")

Example response:

{
  "temperature": [
    { "value": 22.5, "timestamp": 1774690200000 },
    { "value": 23.1, "timestamp": 1774690205000 },
    { "value": 22.8, "timestamp": 1774690210000 }
  ],
  "humidity": [
    { "value": 61.3, "timestamp": 1774690200000 },
    { "value": 60.8, "timestamp": 1774690205000 }
  ]
}

If a metric has no data in the queried range, the array will be empty:

{
  "temperature": [],
  "humidity": []
}

History retention

History retention depends on your plan. For example, the free plan retains 3 days of history. Queries outside your retention window will return empty arrays.

latest()

Get the most recent reading for each metric.

JavaScript

await app.telemetry.latest(params)

Python

await app.telemetry.latest(params)

Parameter	Type	Description
device_ident	string	The device identifier
fields	string[]	Metrics to query
start	string	Start of lookup window (ISO 8601)
end	string	End of lookup window (ISO 8601)

Returns an object keyed by metric name, each containing the latest value and time

JavaScript

const latest = await app.telemetry.latest({
  device_ident: "sensor_01",
  fields: ["temperature", "humidity"],
  start: "2026-03-28T00:00:00.000Z",
  end: "2026-03-29T00:00:00.000Z",
});

// latest.temperature = { value: 25.3, time: "2026-03-28T23:59:00.000Z" }
console.log("Temperature:", latest.temperature.value);
console.log("Humidity:", latest.humidity.value);

Python

latest = await app.telemetry.latest({
    "device_ident": "sensor_01",
    "fields": ["temperature", "humidity"],
    "start": "2026-03-28T00:00:00.000Z",
    "end": "2026-03-29T00:00:00.000Z",
})

# latest["temperature"] = {"value": 25.3, "time": "2026-03-28T23:59:00.000Z"}
print("Temperature:", latest["temperature"]["value"])
print("Humidity:", latest["humidity"]["value"])

Example response:

{
  "temperature": { "value": 25.3, "time": "2026-03-28T23:59:00.000Z" },
  "humidity": { "value": 60.1, "time": "2026-03-28T23:58:45.000Z" }
}