Read Channel Messages
read_channel_messagesRead-only
Retrieve messages from a Connhex IoT channel using its channel ID. Supports filtering by time range, publisher, metric name, format, and decimation.
Instructions
Read messages from a Connhex IoT channel by its channel ID.
Use this when you already have a channel ID. To go from a device's
business identifier (serial, etc.) to messages, prefer
read_thing_messages, which resolves the channel ID for you from a
thing ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ds | No | Decimation granularity, format "<number><s|m|h|d|w|M|y>" (e.g. "5m", "1h", "1d"). When set, the upstream service buckets messages and aggregates them with dsf. Only applies to SenML-based formats ("messages", "params", "metrics"). | |
| dsf | No | Aggregation function for decimation: max, min, avg, sum, stddev, variance. Defaults to "avg" upstream. | |
| dsv | No | Decimation value type: "v" for numeric SenML values, "vb" for boolean. Defaults to "v" upstream. | |
| name | No | SenML name (metric URN) filter. Only applies to SenML-based formats ("messages", "params", "metrics"). Ignored for "infos". | |
| to_s | No | End time in Unix epoch seconds. Always provide from_s and to_s together when the requested time range is known; this drastically speeds up database queries. The integer part represents whole seconds; the fractional part provides sub-second precision (e.g. 1744243200.183767). | |
| limit | No | Max messages to return (upstream max is 1500). | |
| format | No | Which Connhex Message Policy (CMP) component to read. "messages" (default): time-series sensor data collected during operation (e.g. temperature, pressure). SenML format. Most common format — use for actual measurements or telemetry. "params": runtime-editable configuration parameters of the device (e.g. operating mode, thresholds). SenML format. Use to inspect or verify device settings. "infos": static or rarely-changing device metadata sent at boot or after firmware updates (e.g. serial number, firmware version, hardware revision). JSON format (not SenML). Use to identify or describe the device. name, ds, dsf, and dsv do not apply to this format. "metrics": internal device performance indicators (e.g. CPU usage, RAM consumption, uptime). SenML format. Use for device health monitoring and diagnostics. | messages |
| from_s | No | Start time in Unix epoch seconds. Always provide from_s and to_s together when the requested time range is known; this drastically speeds up database queries. The integer part represents whole seconds; the fractional part provides sub-second precision (e.g. 1744243200.183767). | |
| offset | No | Pagination offset. | |
| publisher | No | Publisher UUID filter. | |
| channel_id | Yes | UUID of the channel. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | Yes | ||
| total | Yes | ||
| offset | Yes | ||
| messages | No |