URL Monitors

Fetch detailed availability metrics and aggregated or non-aggregated API Check metrics across custom time ranges. For example, you can get the p99 and p95 of all the DNS phases of your API 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.

GET /v1/analytics/url-monitors/{id}

URL Monitors

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/analytics/url-monitors/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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": {
    "responseTime": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "dns": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "availability": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "retries": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "responseTime_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "wait_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"
    },
    "tcp_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "tcp_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "firstByte_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_avg": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_max": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_median": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_min": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_p50": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_p90": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_p95": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_p99": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_stddev": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    },
    "download_sum": {
      "unit": "milliseconds",
      "label": "<string>",
      "aggregation": "avg"
    }
  }
}

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

Example:

1440

filterByStatus · enum<string>[]

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

Available options: success, failure

Example:

["failure"]

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, statusCode

metrics · enum<string>[] · required

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

Available options: responseTime, wait, dns, tcp, firstByte, download, availability, retries, responseTime_avg, responseTime_max, responseTime_median, responseTime_min, responseTime_p50, responseTime_p90, responseTime_p95, responseTime_p99, responseTime_stddev, responseTime_sum, wait_avg, wait_max, wait_median, wait_min, wait_p50, wait_p90, wait_p95, wait_p99, wait_stddev, wait_sum, dns_avg, dns_max, dns_median, dns_min, dns_p50, dns_p90, dns_p95, dns_p99, dns_stddev, dns_sum, tcp_avg, tcp_max, tcp_median, tcp_min, tcp_p50, tcp_p90, tcp_p95, tcp_p99, tcp_stddev, tcp_sum, firstByte_avg, firstByte_max, firstByte_median, firstByte_min, firstByte_p50, firstByte_p90, firstByte_p95, firstByte_p99, firstByte_stddev, firstByte_sum, download_avg, download_max, download_median, download_min, download_p50, download_p90, download_p95, download_p99, download_stddev, download_sum

limit · integer · default: 10

Limit the number of results

Required range: 1 <= x <= 100

page · number · default: 1

Page number

Response

200

application/json

Success

checkId · string

name · string

checkType · enum<string>

Available options: API, BROWSER, HEARTBEAT, ICMP, MULTI_STEP, TCP, PLAYWRIGHT, URL, DNS

activated · boolean

muted · boolean

frequency · number

from · string<date>

to · string<date>

tags · string[]

series · string[]

pagination · object

Show child attributes

metadata · object

Show child attributes