Monitors API

List monitors

Your monitors, newest first, with each one's schedule and next due time.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/monitorslive · provenfree

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`status`	no	Filter by monitor status: active or paused	`active`
`cursor`	no	Opaque cursor from the previous page
`limit`	no	Page size, 1-100 (default 25)	`25`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/monitors" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/monitors",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/monitors",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "monitors",
  "endpoint": "/v1/monitors",
  "data": {
    "items": [],
    "count": 0,
    "cursor": null,
    "has_more": false
  },
  "credits_used": 0,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: reviewed response shaper. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`items`	`array \| null`	Nested response fields; optional unless explicitly documented.
`items[].id`	`string \| null`	id
`items[].kind`	`string \| null`	kind
`items[].name`	`string \| null`	name
`items[].description`	`string \| null`	description
`items[].status`	`string \| null`	status
`items[].workflow`	`string \| null`	workflow
`items[].capped_reason`	`string \| null`	capped reason
`items[].target_label`	`string \| null`	target label
`items[].group_id`	`string \| null`	group id
`items[].last_run_at`	`string \| null`	last run at
`items[].last_success_at`	`string \| null`	last success at
`items[].next_run_at`	`string \| null`	next run at
`items[].created_at`	`string \| null`	created at
`items[].schedule_minutes`	`number \| null`	schedule minutes
`items[].estimated_credits_per_run`	`number \| null`	estimated credits per run
`items[].monthly_cap_credits`	`number \| null`	monthly cap credits
`items[].credits_spent_month`	`number \| null`	credits spent month
`items[].consecutive_failures`	`number \| null`	consecutive failures
`items[].target`	`object \| null`	Nested response fields; optional unless explicitly documented.
`items[].subject`	`object \| null`	Nested response fields; optional unless explicitly documented.
`items[].delivery`	`object \| null`	Nested response fields; optional unless explicitly documented.
`items[].last_run`	`object \| null`	Nested response fields; optional unless explicitly documented.
`count`	`number \| null`	Nested response fields; optional unless explicitly documented.
`cursor`	`string \| null`	Nested response fields; optional unless explicitly documented.
`has_more`	`boolean \| null`	Nested response fields; optional unless explicitly documented.

Core response fields reviewed from the public response shaper. Fields vary by requested options; additive fields remain allowed.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

List monitors

Query parameters

Make the request

Response fields and example

More Monitors reference

First call in under a minute