API referenceMonitoring
Overview
Watching a company for register changes — what you monitor, what changed, and where we send it.
Watching a company for register changes — what you monitor, what changed, and where we send it. Managing all three is free; only starting a monitor costs credits.
| Endpoint | Route | Cost |
|---|---|---|
| List monitors | GET /monitors | 0 credits |
| Create a monitor | POST /monitors | 10 credits |
| Retrieve a monitor | GET /monitors/{monitor_id} | 0 credits |
| Update a monitor | PATCH /monitors/{monitor_id} | 0 credits |
| Delete a monitor | DELETE /monitors/{monitor_id} | 0 credits |
| List alerts | GET /alerts | 0 credits |
| List monitor event types | GET /monitor-event-types | 0 credits |
| List notification endpoints | GET /notification-endpoints | 0 credits |
| Create a notification endpoint | POST /notification-endpoints | 0 credits |
| Retrieve a notification endpoint | GET /notification-endpoints/{endpoint_id} | 0 credits |
| Update a notification endpoint | PATCH /notification-endpoints/{endpoint_id} | 0 credits |
| Delete a notification endpoint | DELETE /notification-endpoints/{endpoint_id} | 0 credits |