List incidents
list_incidentsList an organization's monitor and heartbeat incidents, newest first, to see what is or was down and which alerts were sent.
Instructions
List the organization's monitor and heartbeat incidents, newest first, to see what is or was down and which alerts went out. Each item has id, monitor_id or heartbeat_id (exactly one is set), started_at, resolved_at (null while open), cause, cause_detail (the raw check error), acknowledged_at and notification_logs: the alerts sent, oldest first, each with id, channel_type (EMAIL, TELEGRAM, WEBHOOK, SLACK or DISCORD), destination (may be masked), event (TRIGGERED for the first alert and every reminder, RESOLVED for the recovery), sent_at, status (PENDING while a webhook, Slack or Discord delivery is still being tried, then SENT or FAILED) and error (the last delivery error). For one incident's full record use get_incident; for the checks behind it use list_check_results; incidents posted on a status page are list_status_page_incidents. An incident resolves by itself when its monitor or heartbeat recovers. Returns a page: items plus total, page, size and pages. An invalid value is a 422 naming the argument. Example: {"status": "open", "size": 50}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, 1 or more; default 1. | |
| size | No | Rows per page, 1 to 100; default 25. Keep paging until you have seen total rows. | |
| cause | No | Keep one failure cause, such as TIMEOUT, HTTP_5XX or HEARTBEAT_MISSED. | |
| status | No | open or resolved (lowercase); omit it for both. | |
| monitor_id | No | Keep one monitor's incidents: its uuid from list_monitors. | |
| period_days | No | Keep incidents active within the last N days, 1 to 365. An open incident always qualifies, so with status open it changes nothing: use status resolved, or omit status, to see the window take effect. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | Yes | ||
| size | Yes | ||
| items | Yes | ||
| pages | Yes | ||
| total | Yes |