Skip to main content
POST
Run a monitor now
Start a run outside the schedule. The response is the run with status queued. Read it a few seconds later with Get a run, or wait for the monitor.run.completed event.

Authorizations

X-API-Key
string
header
required

Your API key, such as keen_.... Create one in the Keenable console. If you send both this header and Authorization, the API uses this one.

Path Parameters

id
string
required

The monitor's ID, such as mon_3kq9z2c8f1a04b7d9e6f5a21.

Response

The queued run

id
string
required
Example:

"mrun_7x1p4c9d2e8f0a3b5c6d7e8f"

object
enum<string>
required
Available options:
monitor_run
monitor_id
string
required
status
enum<string>
required

cancelled is reserved and not used yet.

Available options:
queued,
running,
completed,
failed,
cancelled
results
object[] | null
required

The pages found since the previous run and not returned by one before, most important first, at most max_results. [] when nothing is new, null until the run completes.

error
object | null
required

Why a failed run failed.

created_at
string<date-time> | null
required
output
object | null

With an output_schema, when the run found pages: structured (the summary in your schema), text and grounding.

changes
any | null

Always null: not available yet.

usage
any | null

Always null: monitors are free for now.

started_at
string<date-time> | null
ended_at
string<date-time> | null