Skip to content

Channel Status Read

To retrieve an array of one or more channel status objects for any channels running in a QIE instance, call the URI: http(s)://<qie_server>:<management_api_port>/channel/status/read with the following payload:

{
   "zoneName": "<desired zone>",
   "channelName": "<desired channel>",
   "formatOutput": true | false
}

Base JSON Payload Definition

Node Description
zoneName The name of the zone containing the channel.
channelName The name of the channel. This can be omitted.
formatOutput True if the response JSON should be formatted as human readable (default=false).

The following response is received if the zone and channel are found:

HTTP Status: 200

[
   {
      "zoneId": "<zone_id>",
      "channelName": "<channel_name>",
      "channelId": "<channel_id>",
      "state": <running_state>,
      "stateDescription": "RUNNING" | "PAUSED" | "ERROR" | "STOPPING" | "STOPPED",
      "receivedCount": <current_received_count>,
      "lastReceived": "<last_message_received_time>",
      "inboundQueue": <current_inbound_queue_size>,
      "processingQueue": <current_processing_queue_size>,
      "outboundQueue": <current_outbound_queue_size>,
      "errorQueue": <current_error_queue_size>,
      "lastError": "<last_message_error_time>",
      "completedCount": <current_completed_count>,
      "isEnabled": true | false,
      "versionInfo": <version_info>,
      "stoppedNodes": [
         "<node id1>",
         "<node id2>",
         ….
      ]
   },
   ….
]
Node Description
zoneId The unique ID of the zone the channel is in.
channelName The name of the channel as shown when logged into the QIE service.
channelId The unique ID of the channel found on the channel properties dialog.
state This is a numeric value between 0 and 4. 0=Stopped, 1=Paused, 2=Running, 3=Error, 4=Stopping
stateDescription The human readable description of the state (STOPPED | PAUSED | RUNNING | ERROR | STOPPING).
receivedCount The current number of messages received. This is a count of all messages that have been received and not yet purged by the retention policy.
lastReceived The timestamp of the last message received on this channel (format = yyyy-MM-dd HH:mm:ss Z, e.g. 2026-05-25 14:32:11 -0600).
inboundQueue The current count of messages that are waiting in the inbound queue to be processed.
processingQueue The current count of messages being processed in this channel.
outboundQueue The current count of messages in the outbound queue waiting to be delivered to another system.
errorQueue The current count of messages in the error queue.
lastError The timestamp of the last errored message (format = yyyy-MM-dd HH:mm:ss Z, e.g. 2026-05-25 14:32:11 -0600).
completedCount The current count of messages that have been completed.
isEnabled The current enabled state. True if the channel is enabled. False if the channel is disabled.
versionInfo The version info specified by the channel author in the channel properties.
stoppedNodes An array of stopped-node identifiers. Each is formatted as {sortDirection}. {nodeName or description} (example: 3. My Destination).

If there is an error processing the request, then the following response is received:

HTTP Status: 400

{
   "error": "<error message>"
}

Example curl commands:

curl -H "apiToken:abc123" --request POST http://qieserver:9999/channel/status/read -d '{"zoneName":"myZoneName","channelName":"myChannelName"}'

curl -H "apiToken:abc123" --request POST http://qieserver:9999/channel/status/read -d "{\"zoneName\":\"myZoneName\",\"channelName\":\"myChannelName\"}"

curl -H @{"apiToken"="abc123"} -Method POST http://qieserver:9999/channel/status/read -Body '{"zoneName":"myZoneName","channelName":"myChannelName"}' | Select-Object -Expand RawContent

Used to return the node processing time stats for a single channel as a JSON object when both the zoneName and channelName are specified.