Skip to content

Get retrospective

GET
/api/v1/incidents/{incident_id}/retrospective
curl --request GET \
--url 'https://api.ultimateteam.ai/api/v1/incidents/example/retrospective?tenant_id=example' \
--header 'X-API-Key: <X-API-Key>'

Returns post-incident retrospective report.

incident_id
required
Incident Id
string
tenant_id
required
Tenant Id

Tenant identifier

string

Tenant identifier

Successful Response

Media typeapplication/json
Retrospective

Post-incident retrospective report.

Args: incident_id: The incident this retrospective covers. title: Retrospective title. summary: Executive summary of the incident. timeline: Chronological incident timeline. root_cause: Root cause analysis (template/placeholder). impact: Impact assessment with metrics. what_went_well: List of positive outcomes. what_went_wrong: List of issues encountered. action_items: Follow-up tasks with assignees. generated_at: ISO timestamp of generation.

object
action_items
Action Items
Array<object>
ActionItem

A post-incident action item.

Args: description: What needs to be done. assignee: Who is responsible (None if unassigned). status: Current status (open, in_progress, done). due_date: Target completion date (ISO, None if unset).

object
assignee
Any of:
string
description
Description
string
""
due_date
Any of:
string
status
Status
string
default: open
generated_at
Generated At
string
impact
ImpactAssessment

Impact assessment for a post-incident review.

Args: tenants_affected: Number of tenants impacted, or None for a platform-wide (“system”) incident that affects all tenants. None is used rather than a fabricated count because an exact active-tenant count requires a tenant repository not available to this generator. duration_seconds: Total incident duration. sla_impact: Whether SLA was breached. error_count: Total errors during the incident.

object
duration_seconds
Duration Seconds
integer
0
error_count
Error Count
integer
0
sla_impact
Sla Impact
boolean
tenants_affected
Any of:
integer
incident_id
Incident Id
string
""
root_cause
Root Cause
string
""
summary
Summary
string
""
timeline
IncidentTimeline

Chronological timeline of events during an incident.

Args: incident_id: The incident this timeline belongs to. entries: List of timeline entries sorted by timestamp. window_start: Start of the incident window (ISO). window_end: End of the incident window (ISO).

object
entries
Entries
Array<object>
TimelineEntry

A single entry in an incident timeline.

Args: timestamp: ISO timestamp of the event. source: Event source (error_tracker, metrics, health, runbook, escalation). description: Human-readable event description. severity: Severity level of the event. data: Optional additional structured data.

object
data
Any of:
object
key
additional properties
any
description
Description
string
""
severity
Severity
string
default: info
source
Source
string
""
timestamp
Timestamp
string
incident_id
Incident Id
string
""
window_end
Window End
string
""
window_start
Window Start
string
""
title
Title
string
""
what_went_well
What Went Well
Array<string>
what_went_wrong
What Went Wrong
Array<string>
Example
{
"action_items": [
{
"description": "",
"status": "open"
}
],
"impact": {
"duration_seconds": 0,
"error_count": 0,
"sla_impact": false,
"tenants_affected": 0
},
"incident_id": "",
"root_cause": "",
"summary": "",
"timeline": {
"entries": [
{
"description": "",
"severity": "info",
"source": ""
}
],
"incident_id": "",
"window_end": "",
"window_start": ""
},
"title": ""
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}