Monitors
Company Monitoring
Watch a company for changes and receive an event when something changes.
A monitor watches one company through one or more sources and records an event
for every change it detects. Set a webhookUrl on the monitor to have each
event delivered as it happens; events are also queryable through the API.
| Task | Operation |
|---|---|
| List the sources for a company | GET /v2/monitors/sources |
| Create a monitor | POST /v2/monitors |
| Read a monitor and its recent events | GET /v2/monitors/{monitorId} |
| List a monitor's events | GET /v2/monitors/{monitorId}/events |
| Re-send an event | POST /v2/monitors/{monitorId}/events/{eventId}/replay |
| Delete a monitor | DELETE /v2/monitors/{monitorId} |
curl -X POST https://api.kausate.com/v2/monitors \
-H "X-API-Key: your_api_key" \
-H "Content-Type: application/json" \
-d '{
"kausateId": "co_de_7KGHtucR88u2omSx3KhaoH",
"sources": ["company_report"],
"scheduleCron": "0 8 * * 1",
"webhookUrl": "https://your-server.com/webhooks/kausate"
}'scheduleCron is a five-field cron expression in UTC and defaults to monthly
(0 0 1 * *). The first check records a baseline; events start from the second
check. Each scheduled check consumes credits, whether or not a change is
detected, and so does each delivered event.
See Monitoring & Webhooks for sources, event codes, filters, delivery and replay.
Last updated on