API Reference

TCP checks

get
https://api.checklyhq.com/v1/analytics/tcp-checks/

Fetch detailed availability metrics and aggregated or non-aggregated TCP Check metrics across custom time ranges. For example, you can get the p99 and p95 of all the check phases of your TCP check together with the availability percentage for any time range.

Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
date

Custom start time of reporting window in unix timestamp format. Setting a custom "from" timestamp overrides the use of any "quickRange".

date

Custom end time of reporting window in unix timestamp format. Setting a custom "to" timestamp overrides the use of any "quickRange".

string
enum
Defaults to last24Hours

Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp.

Allowed:
number
1 to 43200

The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.

filterByStatus
array of strings

Filter based on whether a check result was either failing or passing

filterByStatus
string
enum

Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.

Allowed:
metrics
array of strings
required

Available metrics for TCP Checks. You can pass multiple metrics as a comma separated string.

metrics*
integer
1 to 100
Defaults to 10

Limit the number of results

number
Defaults to 1

Page number

Headers
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago