ESPRMAdminMQTTStatistics
Defined in: src/ESPRMAdminMQTTStatistics.ts:11
Shell class for admin MQTT statistics operations. Methods are added via prototype augmentation in methods/ESPRMAdminMQTTStatistics/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminMQTTStatistics():
ESPRMAdminMQTTStatistics
Returns
Section titled “Returns”ESPRMAdminMQTTStatistics
Methods
Section titled “Methods”getMQTTStatistics()
Section titled “getMQTTStatistics()”getMQTTStatistics<
TResponse>(params?):Promise<TResponse>
Defined in: src/methods/ESPRMAdminMQTTStatistics/GetMQTTStatistics.ts:25
Retrieves MQTT broker usage statistics for the admin deployment.
Type Parameters
Section titled “Type Parameters”TResponse
Section titled “TResponse”TResponse extends GetMQTTStatisticsResponse | GetMQTTStatisticsRawResponse = GetMQTTStatisticsResponse
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filtering parameters for the MQTT statistics query.
Use aggregate=raw to retrieve message payload rows with message_data.
Returns
Section titled “Returns”Promise<TResponse>
MQTT statistics response. Provide a generic type argument when expecting
raw message rows (example: getMQTTStatistics<GetMQTTStatisticsRawResponse>(...)).