Skip to content

Commit

Permalink
feat: updated docs to include tcp check endpoint - [sc-00] (checkly#1214
Browse files Browse the repository at this point in the history
)

* feat: updated docs to include tcp check endpoint - [sc-00]

* chore: fix typo
  • Loading branch information
ejanusevicius authored Feb 17, 2025
1 parent 0ec542a commit 2a2051d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion site/content/docs/analytics/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 2a2051d

Please sign in to comment.