Incidents

Get Incident Summary

Return total, open, and resolved incident counts for the organization.

get/v1/incidents/summary

Request

  • Base URL: https://api.fettle.sh (the document declares no server; this is the origin it was published from)
  • URL: https://api.fettle.sh/v1/incidents/summary
  • Auth: API key in header Authorization

Query parameters

monitor_idstring uuid nullable
cause'TIMEOUT' | 'DNS_FAILURE' | 'CONNECTION_REFUSED' | 'TLS_INVALID' | 'HTTP_4XX' | 'HTTP_5XX' | 'HTTP_UNEXPECTED_STATUS' | 'KEYWORD_MISSING' | 'TOO_MANY_REDIRECTS' | 'TARGET_BLOCKED' | 'PORT_STATE_MISMATCH' | 'INVALID_TARGET' | 'HEARTBEAT_MISSED' | 'HEARTBEAT_FAILED' | 'UNKNOWN'

Structured cause of an incident, across both incident sources.

A superset of the worker's wire FailureKind: every value the worker can report is storable here, plus the causes only the core can observe (a heartbeat that never pinged, a client that reported its own failure). The two enums are declared separately so the worker contract does not grow values the worker never emits — test_enums.py guards the subset relation, which is what keeps process_check_result able to store any incoming failure_kind.

The raw human-readable reason lives in Incident.cause_detail.

period_daysinteger nullable

Headers

X-Organization-Idstring uuid nullable

Response

Successful Response

totalinteger required
openinteger required
resolvedinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.