pagehive

command_queue

Read a site's command queue.

Agent commandsRead-onlyAll plans

What it does

Read a site's command queue. status pending (default) lists commands waiting for the agent, oldest first, including claims whose lease ran out. in_progress, done, failed, or all list newest first. Each entry has the instruction to carry out, which keeps {input} where the visitor's text goes, the visitor's text as input, who sent it, and the page. claim_command and complete_command take a command through the queue.

Plans

Works on every plan: Free, Basic, Pro and Ultra.

Parameters

NameTypeAbout
site_idrequiredstringThe id of the site. list_sites gives the ids of your sites.
statusone of: pending, in_progress, done, failed, allpending (default) lists commands waiting for the agent, oldest first. The others list newest first.
limitintegerHow many commands to return.

Example

Call command_queue with these arguments:

{
  "site_id": "01a1…",
  "status": "pending"
}

Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.

Related guides