Delete a monitor
Beta DELETE /v1/monitors/{monitor_id}
DELETE /v1/monitors/{monitor_id}
Delete a monitor.
- Cost: Free
- Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
- Cache: Not cached.
Parameters#
| Name | Type | Required | Description | In |
|---|---|---|---|---|
monitor_id | string | yes | Monitor id. | path |
Example request#
Set your key in the environment first (see Authentication).
curl
curl -X DELETE "https://api.socialscrape.io/v1/monitors/mon_0123456789abcdef" \
-H "x-api-key: $SOCIALSCRAPE_API_KEY"Python
import os
import requests
res = requests.delete(
"https://api.socialscrape.io/v1/monitors/mon_0123456789abcdef",
headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
)
body = res.json()
if body["ok"]:
print(body["data"])
else:
print(body["error"]["code"], body["error"]["message"])TypeScript
const res = await fetch("https://api.socialscrape.io/v1/monitors/mon_0123456789abcdef", {
method: "DELETE",
headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();
if (body.ok) {
console.log(body.data);
} else {
console.error(body.error.code, body.error.message);
}Example response#
This is a sample with illustrative values. Status 200.
{
"ok": true,
"credits_charged": 0,
"credits_remaining": 5000,
"cached": false,
"cached_at": null,
"request_id": "req_56b5fd791543e639a6c65127",
"data": {
"object": "monitor",
"id": "mon_0123456789abcdef",
"endpoint": "/v1/github/user/repositories",
"params": {
"handle": "torvalds"
},
"interval_minutes": 60,
"webhook_url": "https://example.com/hook",
"active": false,
"created_at": "2026-10-29T14:00:00Z",
"webhook_secret": null,
"last_run_at": "2026-10-29T15:00:00Z",
"next_run_at": null,
"last_error": null
},
"cursor": null,
"has_more": null
}Response#
A Monitor object in data.
See Data models for every field. The envelope around data is described in Responses.
Errors#
Failures are free: credits_charged is 0. Branch on error.code, never on the message.
| Code | HTTP | Retry | Meaning |
|---|---|---|---|
invalid_params | 400 | no | A parameter is missing, unknown or has the wrong type. |
Every request can also fail with the account and platform errors listed on the Errors page.
Related endpoints#
- Create a monitor (
POST /v1/monitors) - List monitors (
GET /v1/monitors) - Send a test event (
POST /v1/monitors/{monitor_id}/test) - Webhook delivery log (
GET /v1/monitors/{monitor_id}/deliveries) - Send an event again (
POST /v1/monitors/events/{event_id}/redeliver) - Monitor events (
GET /v1/monitors/events)