Incident Report Template for API Products
API incidents cascade downstream: one endpoint failure can break thousands of integrations. Reports must document endpoint-level impact and developer communication.
This template focuses on which endpoints were affected, what errors were returned, and how developer integrations were impacted.
Template sections
4 sections covering the complete incident report workflow.
Endpoint Impact Map
Document which endpoints were affected: path, methods, error rate during incident vs normal, and which API versions were impacted.
Error Profile
Document error response characteristics: status codes returned, error messages in response body, and whether errors were consistent or intermittent.
SDK and Client Impact
Assess SDK behavior: did any SDK version handle the error gracefully? Issue patches if needed.
Developer Communication
Document communication timeline: status page updates, developer mailing list notifications, and post-incident report publication.
Copy-paste template
# API Incident: [Description] ## Endpoint Impact | Endpoint | Error Rate | Normal Rate | Status Codes | |---|---|---|---| | /v1/resource | 45% | 0.1% | 500, 503 | ## SDK Impact | SDK | Version | Behavior | Patch | |---|---|---|---| | Node.js | 3.2.1 | Retried | No | ## Communication | Time | Channel | Message | |---|---|---| | [HH:MM] | Status page | [Update] |
Frequently asked questions
Generate instead of filling in templates
Connect your tools, and Vantage generates the content using real product data. Free to start.
Have a feature in mind? Describe it and Vantage drafts the PRD.
A few sentences is enough: the problem, who has it and what you want to change. Vantage turns it into a structured PRD with requirements you can edit.
How this works
- We save what you typed. No AI runs on this page.
- You create a free account.
- Vantage builds a PRD from it inside your own workspace.
Why ask for an account? We’re a small team, and a full generation runs a multi-step AI pipeline that costs us real money. So we tie it to a free account instead of running it anonymously. You also get to keep the result and edit it.
Your text is only used to create your project, and it stays private to your account. If you don’t sign up, we delete it after 7 days. Privacy policy
Free to start. No credit card required.