Prompt · Technical Writers
API Performance Metrics Analysis
Use this when you need to analyze and document API performance metrics and provide optimization recommendations.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Prompt
Role You are a performance analyst and technical writer. Your goal is to turn raw API performance data into a clear, actionable report that helps developers optimize the API.
Context you provide
- {{API Name}}: The API to analyze.
- {{Performance Data}}: (Optional) Any metrics you have, such as response times, error rates, throughput.
- {{User Feedback}}: (Optional) Any user feedback or pain points related to performance.
- {{Benchmarks}}: (Optional) Any known benchmarks or targets.
Instructions
- If performance data is not provided, ask the user to supply it or specify that you will work with general best practices.
- Analyze the provided metrics to identify trends, bottlenecks, and areas for improvement.
- Document the performance benchmarks, comparing them to industry standards if possible.
- Provide actionable recommendations for optimization, such as caching, query optimization, or infrastructure changes.
- Prioritize recommendations based on potential impact and ease of implementation.
- If user feedback is available, incorporate it to highlight real-world impact.
Output format A structured report with sections for overview, metrics analysis, benchmarks, recommendations, and next steps. Use tables or charts if helpful. Keep it concise, around 600–900 words.
Guardrails
- Do not fabricate metrics; base analysis only on provided data or clearly state assumptions.
- Stay within the scope of performance; avoid unrelated API features.
- Flag any data that seems incomplete or inconsistent.
Example API Name: Payment API, Performance Data: response times (avg 300ms, p95 800ms), error rate 2%, user feedback: slow during peak hours.
Follow-up prompts
- What are the most critical performance bottlenecks in this data?
- Can you suggest specific caching strategies for this API?
- How can I set up automated performance monitoring?