From 9660ad17810507cabb22b780d8736378fc5cba21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tore=20Stendal=20L=C3=B8n=C3=B8y?= Date: Fri, 7 Feb 2025 08:07:18 +0100 Subject: [PATCH] chore(docs): add section about response time chart --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 1b3e88f1..5daa216d 100644 --- a/README.md +++ b/README.md @@ -2385,6 +2385,19 @@ Where: - `{duration}` is `30d`, `7d`, `24h` or `1h` - `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +#### Response time (chart) +![Response time 1h](https://status.twin.sh/api/v1/endpoints/core_blog-external/response-times/1h/chart.svg) +![Response time 24h](https://status.twin.sh/api/v1/endpoints/core_blog-external/response-times/24h/chart.svg) +![Response time 7d](https://status.twin.sh/api/v1/endpoints/core_blog-external/response-times/7d/chart.svg) +![Response time 30d](https://status.twin.sh/api/v1/endpoints/core_blog-external/response-times/30d/chart.svg) + +The endpoint to generate a response time chart is the following: +``` +/api/v1/endpoints/{key}/response-times/{duration}/chart.svg +``` +Where: +- `{duration}` is `30d`, `7d`, `24h` or `1h` +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. ##### How to change the color thresholds of the response time badge To change the response time badges' threshold, a corresponding configuration can be added to an endpoint.