From 2a2051de6c9a976efa5519af9c7d571a4dddbf68 Mon Sep 17 00:00:00 2001 From: Eddy <53275685+ejanusevicius@users.noreply.github.com> Date: Mon, 17 Feb 2025 15:39:16 +0000 Subject: [PATCH] feat: updated docs to include tcp check endpoint - [sc-00] (#1214) * feat: updated docs to include tcp check endpoint - [sc-00] * chore: fix typo --- site/content/docs/analytics/_index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/site/content/docs/analytics/_index.md b/site/content/docs/analytics/_index.md index 98dac1b2b..67e27366e 100644 --- a/site/content/docs/analytics/_index.md +++ b/site/content/docs/analytics/_index.md @@ -27,9 +27,10 @@ or keep reading for more examples! There are three main endpoints. -1. `/v1/analytics/metrics/`: returns all the available metrics for a specific check-type (`API` or `BROWSER`) +1. `/v1/analytics/metrics/`: returns all the available metrics for a specific check-type (`API`, `TCP` or `BROWSER`) 2. `/v1/analytics/browser-checks/{checkId}`: returns metrics for Browser checks. 3. `/v1/analytics/api-checks/{checkId}`: returns metrics for API checks. +4. `/v1/analytics/tcp-checks/{checkId}`: returns metrics for TCP checks. The specific endpoints per check type return a JSON response that includes a check's attributes, period requested, grouped `series` and a `metadata` section where you'll have additional information about the metrics to create rich reports.