Skip to main content
GET
Get Monitor

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Path Parameters

monitor_id
string
required
Pattern: ^monitor_

Query Parameters

include_total_count
enum<string>

Set to false or 0 to omit total_count.

Available options:
true,
false,
0,
1
include-diagram
enum<string>

When true, includes mermaid_diagram for the monitor DAG.

Available options:
true,
1

Response

Monitor retrieved.

id
string

Unique monitor identifier (monitor_…).

object
string
Example:

"monitor"

query
string

Monitoring intent in natural language.

tracked
object

Resolved targets the monitor tracks after planning completes.

source_policy
object

Optional URL/domain allow and deny lists applied during planning and execution.

schedule
object
notification
object
webhook
object | null
output_schema
object | null

Optional JSON Schema for structured extraction output.

status
enum<string>

Monitor lifecycle status.

Available options:
provisioning,
active,
paused,
failed,
deleted
error_message
string | null

Present when status is failed.

last_run
object | null

Latest snapshot summary. Included on GET /v1/monitors/{monitor_id}.

agent
object
metadata
object
created
integer

Unix timestamp (seconds).

updated
integer

Unix timestamp (seconds).

total_count
integer

Total snapshot count. Included on GET /v1/monitors/{monitor_id} unless include_total_count=false.

mermaid_diagram
string

Mermaid flowchart of the monitor DAG. Included when include-diagram=true on get.