Berichte

Zwei Berichte über einen expliziten Zeitraum, jeweils als JSON oder als CSV-Download.

AuthentifizierungAnkerlink kopieren

Jede IM-berechtigte Rolle (admin, editor, responder) oder ein organisationsweiter API-Token. Incident Management muss für die Organisation aktiviert sein.

ZeitraumAnkerlink kopieren

Beide Berichte verlangen from und to als ISO 8601. from zählt mit, to nicht, to muss nach from liegen, und der Zeitraum darf höchstens 400 Tage umfassen.

Incident-BerichtAnkerlink kopieren

GET /api/im/reports/incidents

Zählt die im Zeitraum ausgelösten Incidents und ihre mittlere Zeit bis zur Bestätigung (MTTA) und bis zur Lösung (MTTR), in Minuten. Ein Incident, der nie bestätigt oder gelöst wurde, fällt aus dem jeweiligen Durchschnitt heraus, er zählt nicht als null. Test-Incidents zählen nicht mit.

Query-ParameterAnkerlink kopieren

Beispiel (cURL)Ankerlink kopieren

curl "$BASE_URL/api/im/reports/incidents?from=2026-07-01T00:00:00Z&to=2026-10-01T00:00:00Z&groupBy=severity" \
  -H "Authorization: Bearer $TOKEN"

Antwort (Response)Ankerlink kopieren

{
  "from": "2026-07-01T00:00:00.000Z",
  "to": "2026-10-01T00:00:00.000Z",
  "groupBy": "severity",
  "summary": { "count": 27, "mttaMinutes": 6.4, "mttrMinutes": 82.15 },
  "groups": [
    { "groupKey": "sev1", "groupLabel": "sev1", "count": 3, "mttaMinutes": 1.8, "mttrMinutes": 41.5 },
    { "groupKey": "sev3", "groupLabel": "sev3", "count": 24, "mttaMinutes": 7.1, "mttrMinutes": 87.24 }
  ]
}

groupKey / groupLabel je Gruppierung: team liefert Team-ID und Teamname, severity liefert sev1 bis sev4, month liefert in beiden Feldern den UTC-Zeitpunkt des lokalen Monatsbeginns (z. B. 2026-08-31T22:00:00.000Z für August bei tz=120). Gruppen ohne Incidents fehlen. Durchschnitte sind auf zwei Nachkommastellen gerundet und null, wenn kein Incident der Gruppe in Frage kommt.

Mit format=csv ist die Antwort text/csv mit Content-Disposition: attachment; filename="incidents-report-<date>.csv" und den Spalten <groupBy>,count,mttaMinutes,mttrMinutes. Monate stehen als YYYY-MM darin, leere Durchschnitte als leere Zellen. Die Zusammenfassung ist nicht Teil der CSV.

On-Call-BerichtAnkerlink kopieren

GET /api/im/reports/on-call

On-Call-Minuten pro Person innerhalb des Zeitraums. Schichten, die vor from beginnen oder nach to enden, zählen nur mit ihrem Anteil im Zeitraum. Team-Overrides vom Typ online (ohne Schedule) kommen zu den geplanten Schichten hinzu.

Query-ParameterAnkerlink kopieren

Beispiel (cURL)Ankerlink kopieren

curl "$BASE_URL/api/im/reports/on-call?from=2026-09-01T00:00:00Z&to=2026-10-01T00:00:00Z" \
  -H "Authorization: Bearer $TOKEN"

Antwort (Response)Ankerlink kopieren

{
  "periodStart": "2026-09-01T00:00:00.000Z",
  "periodEnd": "2026-10-01T00:00:00.000Z",
  "users": [
    { "userId": "u_abc123", "userName": "Jana Weber", "minutes": 21600 },
    { "userId": "u_def456", "userName": "Tobias Brandt", "minutes": 21600 }
  ]
}

users ist nach userId sortiert, minutes auf zwei Nachkommastellen gerundet. Personen ohne On-Call-Zeit im Zeitraum fehlen.

Mit format=csv ist die Antwort text/csv mit Content-Disposition: attachment; filename="on-call-report-<date>.csv" und den Spalten userId,userName,minutes,hours.

Häufige FehlerAnkerlink kopieren

• 401 Unauthorized (unauthorized) wenn du nicht authentifiziert bist
• 403 Forbidden (customerScopedTokenForbidden) bei einem kunden-gescopten Token
• 403 Forbidden (imAccessDenied) wenn deine Session keine IM-berechtigte Rolle hat
• 403 Forbidden (imNotEnabled) wenn Incident Management für die Organisation nicht aktiviert ist
• 400 Bad Request (imReportRangeRequired) wenn from oder to fehlt oder kein gültiges Datum ist
• 400 Bad Request (imReportRangeInvalid) wenn from nicht vor to liegt
• 400 Bad Request (imReportRangeTooLarge) wenn der Zeitraum 400 Tage überschreitet