API reference
Send a Sample Alert API
Sends one clearly-marked sample alert (a short report with receipts) to the destinations given, right now, and reports what each one answered. Nothing is recorded, nothing is charged, and no real finding is involved: it proves the channel works before a monitor is switched on.
Endpoint
GET/v1/monitors/test-deliverylive · 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 |
|---|---|---|---|
destinations | yes | The destinations to send the sample to, as for monitors/create | [{"kind":"endpoint","endpoint_id":"whk_…"}] |
name | no | The monitor name to show on the sample | Monzo complaints |
id | no | The monitor the sample is sent from, when it already exists: the sample then links to that monitor’s page and takes its name. Without it, the sample links to the monitors list. | mon_… |
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/test-delivery?destinations=%5B%7B%22kind%22%3A%22endpoint%22%2C%22endpoint_id%22%3A%22whk_%E2%80%A6%22%7D%5D&id=mon_%E2%80%A6" \ -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/test-delivery?destinations=%5B%7B%22kind%22%3A%22endpoint%22%2C%22endpoint_id%22%3A%22whk_%E2%80%A6%22%7D%5D&id=mon_%E2%80%A6",
{ 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/test-delivery?destinations=%5B%7B%22kind%22%3A%22endpoint%22%2C%22endpoint_id%22%3A%22whk_%E2%80%A6%22%7D%5D&id=mon_%E2%80%A6",
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/test-delivery",
"data": {
"sent": 0,
"failed": 0,
"results": [],
"sample": false,
"note": null
},
"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 |
|---|---|---|
sent | number | null | Nested response fields; optional unless explicitly documented. |
failed | number | null | Nested response fields; optional unless explicitly documented. |
results | array | null | Nested response fields; optional unless explicitly documented. |
results[].destination | string | null | Nested response fields; optional unless explicitly documented. |
results[].kind | string | null | Nested response fields; optional unless explicitly documented. |
results[].ok | boolean | null | Nested response fields; optional unless explicitly documented. |
results[].real | boolean | null | Nested response fields; optional unless explicitly documented. |
results[].detail | string | null | Nested response fields; optional unless explicitly documented. |
sample | boolean | null | Nested response fields; optional unless explicitly documented. |
note | string | 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