Skip to main content
GET
/
v1
/
monitors
/
{monitor_id}
Get Monitor
curl --request GET \
  --url https://api.olostep.com/v1/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "monitor_5hktz469jy",
  "object": "monitor",
  "created_at": 1777983215,
  "cron_expression": "13 13 * * ? *",
  "fda_id": "fda_5hktz469jy",
  "frequency": "daily",
  "metadata": {},
  "notification_channel": "email",
  "notification_target": "example@olostep.com",
  "query": "Gather the new blogposts from example website and send me updates with new posts.",
  "status": "active",
  "team_id": "team_5hktz469jyF",
  "updated_at": 1777983222
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

monitor_id
string
required

Unique monitor identifier. Must start with monitor_.

Pattern: ^monitor_

Response

Monitor retrieved successfully.

id
string

Unique monitor identifier.

object
string
Example:

"monitor"

team_id
string
status
enum<string>

Monitor lifecycle status. Common values: active (running on schedule), paused (schedule disabled via /pause, can be resumed via /resume), deleted (soft-deleted).

Available options:
active,
paused,
deleted
fda_id
string
query
string

Monitoring intent in natural language. If the query includes a URL, the monitor will focus on that URL.

frequency
string

Natural-language schedule instruction (for example: 'every day at 9am America/Los_Angeles' or 'every weekday at 14:30'). If no timezone is specified, UTC is used.

cron_expression
string | null
notification_channel
enum<string>
Available options:
email,
webhook,
sms
notification_target
string
metadata
object
output_schema
object

Optional JSON schema used to enforce structured monitor extraction output.

error_message
string | null
created_at
integer

Unix timestamp.

updated_at
integer

Unix timestamp.