Users need the flexibility to export the entire contents of a retrospective via a public Blameless API, including the Analysis section.
The enhanced retrospective API return the following data for a retrospective:
- Summary
- Analysis section
- Customer Questions with the answers
- Impact section: all impact timestamps available at the time of the API call
- Root causes
- Events
- Comments
- Teams
GET api/v1/incidents/<incident_id>/retrospective/bundle
| Property | Type | Required | Description |
|---|---|---|---|
| Method | GET |
||
| Customer | String | Yes | The slug of your organization cluster |
| Path | String | Yes | /api/v1/incidents/<incidentId>/retrospective/bundle |
| Auth | Yes | Bearer with valid authorization token | |
| Path Parameters | Integer | Yes | The incident ID |
curl\
-H 'content-type: application/json'\
-H 'Authorization: Bearer <token>'\
https://<customer>.blameless.io/api/v1/incidents/342/retrospective/bundle
Note: Fields identified in the samples are the minimum returned. The response may contain additional fields.
The sample response returns a retrospective containing one or more identified incident properties and values. It creates an RI tile with retrospective analysis as a data point, and sees all analysis data as expected.
{
"ok": true,
"result":{
"summary":"Frequent upload performance degradation",
"analysis":"## What happened\n\n\n\n\n1. ### The Setting\n\n2. ### The Problem\n\n3. ### Resolution\n\n\n\n\n## Lessons learned\n\n\n\n\n1. #### What went well\n\n2. #### What went wrong\n\n3. #### Where we got lucky",
"impact":{
"created_at":"Apr 12, 2022 07:41 PM",
"start_of_customer_impact":"Apr 12, 2022 07:41 PM",
"end_of_customer_impact":"Apr 12, 2022 07:45 PM",
"duration_of_customer_impact":"4m 2s",
"start_of_incident_impact":"Apr 12, 2022 07:41 PM",
"end_of_incident_impact":"Apr 12, 2022 07:45 PM",
"duration_of_incident_impact":"4m 2s",
"time_to_resolution":"4m 2s",
"resolved_at":"Apr 12, 2022 07:45 PM"
},
"custom_questions":{
"detected":"alerts_monitoring",
"repeat_incident":"no",
"contributing_factors":[
"Configuration Failure"
],
"service":[
"Login"
]
},
"root_cause":[
{
"why":"slow primary service performance",
"because":"scale"
}
],
"events":[
{
"incident_id":2183,
"date":"Apr 12, 2022 07:41 PM",
"event_type":"INCIDENT_CREATED"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:41 PM",
"event_type":"START_OF_CUSTOMER_IMPACT"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:41 PM",
"event_type":"START_OF_INCIDENT_IMPACT"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:41 PM",
"event_type":"RETROSPECTIVE_STATE_CHANGED",
"value":"UNASSIGNED"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:41 PM",
"event_type":"PAGER_TRIGGERED",
"value":"instance.blameless.io/incidents/2183"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:41 PM",
"event_type":"PAGER_TRIGGERED",
"value":"instance.blameless.io/incidents/2183"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:42 PM",
"event_type":"SWIMLANE_CREATED",
"value":"test close and achive"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:45 PM",
"event_type":"ROLES_FIELD_CHANGED",
"value":{
"role":"Communication Lead",
"user":"Leonardo Alessi"
}
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:45 PM",
"event_type":"END_OF_CUSTOMER_IMPACT"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:45 PM",
"event_type":"END_OF_INCIDENT_IMPACT"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:45 PM",
"event_type":"STATUS_FIELD_CHANGED",
"value":"RESOLVED"
},
{
"incident_id":2183,
"date":"Apr 12, 2022 07:46 PM",
"event_type":"RETROSPECTIVE_STATE_CHANGED",
"value":"PUBLISHED"
}
],
"comments":[
{
"id":283,
"created_at":"Apr 15, 2022 02:20 AM",
"created_by":{
"id":1850,
"name":"John Smith"
},
"text":"Improve services",
"resolved": false,
"resolved_at": null,
"resolved_by": null,
"replies":[]
}
],
"team":[
{
"roles":[
"Creator",
"Commander"
],
"name":"Peter Fitzgerald"
},
{
"roles":[
"Participant"
],
"name":"Jamie Wayne"
},
{
"roles":[
"Participant"
],
"name":"Liza Federal"
}
]
}
}.svg)
Comments
0 comments
Article is closed for comments.