API reference
Monitor Metric Timeseries API
One numeric metric from a monitor's runs as a chartable time series.
Endpoint
GET/v1/monitors/timeserieslive · provenfreeParameters
Query parameters
Useful optional inputs
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | Monitor id | mon_0f2c8b1d4e6a7c9b0d1e2f3a |
metric | yes | Metric key to chart; a 422 lists the metrics this monitor has recorded | content_length |
from | no | Only points at or after this ISO-8601 time | 2026-01-01T00:00:00Z |
to | no | Only points at or before this ISO-8601 time | 2026-02-01T00:00:00Z |
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. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/monitors/timeseries?id=mon_0f2c8b1d4e6a7c9b0d1e2f3a&metric=content_length" \ -H "x-api-key: mn_your_key_here"
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/timeseries?id=mon_0f2c8b1d4e6a7c9b0d1e2f3a&metric=content_length",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/monitors/timeseries?id=mon_0f2c8b1d4e6a7c9b0d1e2f3a&metric=content_length",
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.
{
"success": true,
"platform": "monitors",
"endpoint": "/v1/monitors/timeseries",
"data": {
"monitor_id": null,
"metric": null,
"from": null,
"to": null,
"count": 0,
"points": []
},
"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 |
|---|---|---|
monitor_id | string | null | monitor id |
metric | string | null | metric |
from | string | null | from |
to | string | null | to |
count | number | null | Nested response fields; optional unless explicitly documented. |
points | array | null | Nested response fields; optional unless explicitly documented. |
points[].t | string | null | Nested response fields; optional unless explicitly documented. |
points[].value | number | 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