GetMQTTStatisticsParams
Defined in: src/types/mqtt_statistics.ts:74
Query parameters for retrieving MQTT usage statistics.
Properties
Section titled “Properties”aggregate?
Section titled “aggregate?”
optionalaggregate?:string
Defined in: src/types/mqtt_statistics.ts:86
Aggregation measure (e.g. count).
aggregation_interval?
Section titled “aggregation_interval?”
optionalaggregation_interval?:string
Defined in: src/types/mqtt_statistics.ts:88
Aggregation interval aligned with dashboard stats (e.g. day, week).
end_time?
Section titled “end_time?”
optionalend_time?:number
Defined in: src/types/mqtt_statistics.ts:96
End of the time range as a Unix timestamp (seconds).
fw_version?
Section titled “fw_version?”
optionalfw_version?:string
Defined in: src/types/mqtt_statistics.ts:84
Filter by node firmware version.
group_by?
Section titled “group_by?”
optionalgroup_by?:string
Defined in: src/types/mqtt_statistics.ts:100
Group results (e.g. topic_name, node_id).
node_id?
Section titled “node_id?”
optionalnode_id?:string
Defined in: src/types/mqtt_statistics.ts:82
Filter by node id for GET /admin/mqtt_stats (query key node_id).
num_records?
Section titled “num_records?”
optionalnum_records?:string|number
Defined in: src/types/mqtt_statistics.ts:90
Maximum number of records to return per page.
start_id?
Section titled “start_id?”
optionalstart_id?:string
Defined in: src/types/mqtt_statistics.ts:92
Pagination cursor from the previous response (next_id).
start_time?
Section titled “start_time?”
optionalstart_time?:number
Defined in: src/types/mqtt_statistics.ts:94
Start of the time range as a Unix timestamp (seconds).
timezone?
Section titled “timezone?”
optionaltimezone?:string
Defined in: src/types/mqtt_statistics.ts:98
Timezone for the statistics data.
topic_name?
Section titled “topic_name?”
optionaltopic_name?:string
Defined in: src/types/mqtt_statistics.ts:78
Filter by MQTT topic pattern for GET /admin/mqtt_stats (query key topic_name).