GET
/
v1
/
analytics
/
tcp-checks
/
{id}
TCP checks
curl --request GET \
  --url https://api.checklyhq.com/v1/analytics/tcp-checks/{id} \
  --header 'Authorization: <api-key>'
{
  "checkId": "<string>",
  "name": "<string>",
  "checkType": "API",
  "activated": true,
  "muted": true,
  "frequency": 123,
  "from": "2023-12-25",
  "to": "2023-12-25",
  "tags": [
    "<string>"
  ],
  "series": [
    "<string>"
  ],
  "pagination": {
    "page": 123,
    "limit": 123
  },
  "metadata": {
    "total": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "availability": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "retries": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "total_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "connection_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "data_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    }
  }
}

​
Overview

The TCP Check Analytics endpoint provides detailed availability metrics and aggregated TCP check data across custom time ranges. This endpoint helps you analyze the performance of your TCP connection monitoring and network reliability checks. Common Use Cases:
  • TCP Connection Performance Analysis
  • Network Reliability Monitoring
  • Port Availability Tracking
  • Connection Time Analysis
Rate Limiting: 30 requests per 60 seconds
This endpoint provides TCP-specific metrics including connection times, availability percentages, and retry statistics to help monitor network-level service availability.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

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

Path Parameters

​
id
string
required

Query Parameters

​
from
string<date>

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

​
to
string<date>

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

​
quickRange
enum<string>
default: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.

Available options:
last24Hours,
last7Days,
last30Days,
thisWeek,
thisMonth,
lastWeek,
lastMonth
​
aggregationInterval
number

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

Required range: 1 <= x <= 43200
​
filterByStatus
enum<string>[]

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

​
groupBy
enum<string>

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

Available options:
runLocation
​
metrics
enum<string>[]
required

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

​
limit
integer
default:10

Limit the number of results

Required range: 1 <= x <= 100
​
page
number
default:1

Page number

Response

Success

​
checkId
string
​
name
string
​
checkType
enum<string>
Available options:
API,
BROWSER,
HEARTBEAT,
MULTI_STEP,
TCP,
PLAYWRIGHT,
URL
​
activated
boolean
​
muted
boolean
​
frequency
number
​
from
string<date>
​
to
string<date>
​
tags
string[]
​
series
string[]
​
pagination
object
​
metadata
object