Command APIs

Get statistics for a specific command.

This API retrieves statistics for a specific command based on its ID.

get/rest/command/getcommandstats/{commandId}

Request

  • Base URL
    https://masonconsole.com
  • Auth
    HTTP bearer

Path parameters

commandIdstring required

Response

Successful response

totalDevicesinteger

Total number of devices associated with the command.

successinteger

Number of successful executions of the command.

readyinteger

Number of devices ready to receive the command.

executedinteger

Number of times the command has been executed.

failinteger

Number of failed executions of the command.

countinteger

Total count.

readyArrstring[]

List of device IDs that are ready to receive the command.

Example response

{
  "totalDevices": 100,
  "success": 80,
  "ready": 90,
  "executed": 120,
  "fail": 20,
  "count": 150,
  "readyArr": [
    "device_id_1",
    "device_id_2"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.