Get Monitor

Retrieves a monitor by ID, including last_run and total_count. Use include-diagram=true for a Mermaid DAG diagram and include_total_count=false to omit the snapshot count.

GET /v1/monitors/{monitor_id}

Get Monitor

cURL

curl --request GET \
  --url https://api.olostep.com/v1/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "object": "monitor",
  "query": "<string>",
  "tracked": {
    "type": "<string>",
    "urls": [
      "<string>"
    ],
    "web_query": "<string>"
  },
  "source_policy": {
    "include_urls": [
      "<string>"
    ],
    "exclude_urls": [
      "<string>"
    ],
    "include_domains": [
      "<string>"
    ],
    "exclude_domains": [
      "<string>"
    ]
  },
  "schedule": {
    "frequency": "<string>",
    "cron": "<string>",
    "timezone": "UTC",
    "next_run_at": "2023-11-07T05:31:56Z"
  },
  "notification": {
    "events": [],
    "channels": [
      {
        "target": "<string>",
        "events": []
      }
    ]
  },
  "webhook": {
    "url": "<string>"
  },
  "output_schema": {},
  "error_message": "<string>",
  "last_run": {
    "id": "<string>",
    "status": "completed",
    "change_detected": true,
    "ran_at": "2023-11-07T05:31:56Z"
  },
  "agent": {
    "id": "<string>"
  },
  "metadata": {},
  "created": 123,
  "updated": 123,
  "total_count": 123,
  "mermaid_diagram": "<string>"
}

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

200

application/json

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.

Show child attributes

source_policy · object

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

Show child attributes

schedule · object

Show child attributes

notification · object

Show child attributes

webhook · object

Show child attributes

output_schema · object

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

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

Show child attributes

agent · object

Show child attributes

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.