API checks

get https://api.checklyhq.com/v1/analytics/api-checks/{id}

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.

Path Params

string

required

Query Params

from

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".

quickRange

string

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.

aggregationInterval

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

groupBy

string

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

metrics

array of strings

required

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

metrics*

limit

integer

1 to 100

Defaults to 10

Limit the number of results

page

number

Defaults to 1

Page number

Headers

x-checkly-account

string

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

Responses

Response body

object

checkId

string

name

string

checkType

string

API BROWSER HEARTBEAT MULTI_STEP TCP PLAYWRIGHT

activated

boolean

muted

boolean

frequency

number

from

date

tags

series

array of strings

series

pagination

object

page

number

limit

number

metadata

object

responseTime

object

wait

object

dns

object

tcp

object

firstByte

object

download

object

availability

object

retries

object

responseTime_avg

object

responseTime_max

object

responseTime_median

object

responseTime_min

object

responseTime_p50

object

responseTime_p90

object

responseTime_p95

object

responseTime_p99

object

responseTime_stddev

object

responseTime_sum

object

wait_avg

object

wait_max

object

wait_median

object

wait_min

object

wait_p50

object

wait_p90

object

wait_p95

object

wait_p99

object

wait_stddev

object

wait_sum

object

dns_avg

object

dns_max

object

dns_median

object

dns_min

object

dns_p50

object

dns_p90

object

dns_p95

object

dns_p99

object

dns_stddev

object

dns_sum

object

tcp_avg

object

tcp_max

object

tcp_median

object

tcp_min

object

tcp_p50

object

tcp_p90

object

tcp_p95

object

tcp_p99

object

tcp_stddev

object

tcp_sum

object

firstByte_avg

object

firstByte_max

object

firstByte_median

object

firstByte_min

object

firstByte_p50

object

firstByte_p90

object

firstByte_p95

object

firstByte_p99

object

firstByte_stddev

object

firstByte_sum

object

download_avg

object

download_max

object

download_median

object

download_min

object

download_p50

object

download_p90

object

download_p95

object

download_p99

object

download_stddev

object

download_sum

object

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.checklyhq.com/v1/analytics/api-checks/id?quickRange=last24Hours&limit=10&page=1' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

403Forbidden

429Too Many Requests