checkly checks - Checkly Docs

Available since CLI v7.3.0. Analytics stats available since v7.6.0.

The checkly checks command lets you list, inspect, and analyze checks in your Checkly account directly from the terminal. You can filter, search, and drill into individual check details, recent results, error groups, and analytics stats.

Prerequisites

Before using checkly checks, ensure you have:

Checkly CLI installed
Valid Checkly account authentication (run npx checkly login if needed)

For additional setup information, see CLI overview.

Usage

Terminal

npx checkly checks <subcommand> [arguments] [options]

Subcommands

Subcommand	Description
`list`	List all checks in your account.
`get`	Get details of a specific check, including recent results and analytics stats.
`stats`	Show analytics stats for your checks.
`delete`	Delete a check by ID.

`checkly checks list`

List all checks in your account with optional filtering by name, tag, check type, or status. Usage:

Terminal

npx checkly checks list [options]

Options:

Option	Required	Description
`--limit, -l`	-	Number of checks to return (1-100). Default: `25`.
`--page, -p`	-	Page number. Default: `1`.
`--search, -s`	-	Filter checks by name (case-insensitive).
`--tag, -t`	-	Filter by tag. Can be specified multiple times.
`--type`	-	Filter by check type.
`--status`	-	Filter by check status: `passing`, `failing`, or `degraded`.
`--hide-id`	-	Hide check IDs in table output.
`--output, -o`	-	Output format: `table`, `json`, or `md`. Default: `table`.

List Options

--limit, -l

number

default:"25"

Number of checks to return per page, between 1 and 100.Usage:

Terminal

npx checkly checks list --limit=50
npx checkly checks list -l 10

--page, -p

number

default:"1"

Page number for paginated results.Usage:

Terminal

npx checkly checks list --page=2
npx checkly checks list -p 3

--search, -s

string

Filter checks by name using a case-insensitive search.Usage:

Terminal

npx checkly checks list --search="homepage"
npx checkly checks list -s "api"

--tag, -t

string

Filter checks by tag. Specify multiple times to filter by multiple tags.Usage:

Terminal

npx checkly checks list --tag=production
npx checkly checks list -t production -t critical

--type

string

Filter checks by type. Available types: API, BROWSER, MULTI_STEP, HEARTBEAT, PLAYWRIGHT, TCP, DNS, ICMP, URL.Usage:

Terminal

npx checkly checks list --type=API
npx checkly checks list --type=BROWSER

--status

string

Filter checks by current status. Available values: passing, failing, degraded.Usage:

Terminal

npx checkly checks list --status=failing
npx checkly checks list --status=degraded

--hide-id

boolean

Hide check IDs in table output for a cleaner view.Usage:

Terminal

npx checkly checks list --hide-id

--output, -o

string

default:"table"

Set the output format. Use json for programmatic access or md for markdown.Usage:

Terminal

npx checkly checks list --output=json
npx checkly checks list -o md

List Examples

Terminal

# List all checks with default settings
npx checkly checks list

# Search for checks by name
npx checkly checks list --search="homepage"

# Filter by tag and type
npx checkly checks list --tag=production --type=API

# Show only failing checks
npx checkly checks list --status=failing

# Get results as JSON
npx checkly checks list --output=json

# Page through results
npx checkly checks list --limit=10 --page=2

`checkly checks get`

Get details of a specific check, including recent results and analytics stats. Use --result to drill into a specific result, --error-group to view error details, or the stats flags to customize the analytics view. Usage:

Terminal

npx checkly checks get <id> [options]

Arguments:

Argument	Description
`id`	The ID of the check to retrieve.

Options:

Option	Required	Description
`--result, -r`	-	Show details for a specific result ID.
`--error-group, -e`	-	Show full details for a specific error group ID.
`--results-limit`	-	Number of recent results to show. Default: `10`.
`--results-cursor`	-	Cursor for results pagination (from previous output).
`--stats-range`	-	Time range for stats: `last24Hours`, `last7Days`, `last30Days`, `thisWeek`, `thisMonth`, `lastWeek`, `lastMonth`. Default: `last24Hours`.
`--group-by`	-	Group stats by dimension: `location` or `statusCode`.
`--metrics`	-	Comma-separated list of metrics to show (overrides defaults).
`--filter-status`	-	Only include runs with this status in stats: `success` or `failure`.
`--output, -o`	-	Output format: `detail`, `json`, or `md`. Default: `detail`.

Get Options

--result, -r

string

Drill into a specific check result by its result ID. Shows detailed information including logs and timing data.Usage:

Terminal

npx checkly checks get <check-id> --result=<result-id>
npx checkly checks get <check-id> -r <result-id>

--error-group, -e

string

Show full details for a specific error group, including error messages and affected results.Usage:

Terminal

npx checkly checks get <check-id> --error-group=<error-group-id>
npx checkly checks get <check-id> -e <error-group-id>

If your account has Rocky AI Root Cause Analysis enabled, the returned error group details include the AI-generated root cause analysis for that error group.

--results-limit

number

default:"10"

Number of recent results to display.Usage:

Terminal

npx checkly checks get <check-id> --results-limit=20

--results-cursor

string

Cursor for paginating through results. The cursor value is provided in the output of a previous checks get command.Usage:

Terminal

npx checkly checks get <check-id> --results-cursor=<cursor>

--stats-range

string

default:"last24Hours"

Time range for the analytics stats section. Available ranges: last24Hours, last7Days, last30Days, thisWeek, thisMonth, lastWeek, lastMonth.Usage:

Terminal

npx checkly checks get <check-id> --stats-range=last7Days

--group-by

string

Group analytics stats by a specific dimension. Use location to break down metrics by geographic region, or statusCode to group by HTTP status code.Usage:

Terminal

npx checkly checks get <check-id> --group-by=location
npx checkly checks get <check-id> --group-by=statusCode

--metrics

string

Comma-separated list of metrics to display, overriding the defaults. When omitted, a sensible set of defaults is used based on the check type. You can also retrieve the full list of available metrics from the List all available reporting metrics API endpoint.Available metrics by check type:

Metric	Applies to	Unit
`availability`	All check types	%
`responseTime_avg`	API, Browser, Playwright, Multi-Step, URL	ms
`responseTime_p50`	API, Browser, Playwright, Multi-Step, URL	ms
`responseTime_p95`	API, Browser, Playwright, Multi-Step, URL	ms
`responseTime_p99`	API, Browser, Playwright, Multi-Step, URL	ms
`total_avg`	TCP, DNS	ms
`total_p50`	TCP, DNS	ms
`total_p95`	TCP, DNS	ms
`total_p99`	TCP, DNS	ms
`latencyAvg_avg`	ICMP	ms
`latencyAvg_p50`	ICMP	ms
`latencyAvg_p95`	ICMP	ms
`latencyAvg_p99`	ICMP	ms
`packetLoss_avg`	ICMP	%
`LCP_avg`	Browser, Playwright	ms
`CLS_avg`	Browser, Playwright	score
`TBT_avg`	Browser, Playwright	ms

Default metrics per check type:

Check type	Default metrics
API, Multi-Step, URL	`availability`, `responseTime_avg`, `responseTime_p50`, `responseTime_p95`, `responseTime_p99`
Browser, Playwright	`availability`, `LCP_avg`, `CLS_avg`, `TBT_avg`, `responseTime_avg`, `responseTime_p95`
TCP, DNS	`availability`, `total_avg`, `total_p50`, `total_p95`, `total_p99`
ICMP	`availability`, `packetLoss_avg`, `latencyAvg_avg`, `latencyAvg_p50`, `latencyAvg_p95`, `latencyAvg_p99`
Heartbeat	`availability`

Usage:

Terminal

npx checkly checks get <check-id> --metrics=availability,responseTime_avg,responseTime_p95

--filter-status

string

Only include runs with a specific status in the analytics stats. Use success to see stats for passing runs only, or failure for failing runs.Usage:

Terminal

npx checkly checks get <check-id> --filter-status=failure
npx checkly checks get <check-id> --filter-status=success

--output, -o

string

default:"detail"

Set the output format. Use json for programmatic access or md for markdown.Usage:

Terminal

npx checkly checks get <check-id> --output=json
npx checkly checks get <check-id> -o md

Get Examples

Terminal

# View check details, recent results, and stats
npx checkly checks get 12345

# View stats for the last 7 days
npx checkly checks get 12345 --stats-range=last7Days

# Break down stats by location
npx checkly checks get 12345 --group-by=location

# Show only specific metrics
npx checkly checks get 12345 --metrics=availability,responseTime_avg,responseTime_p95

# Show stats for failed runs only
npx checkly checks get 12345 --filter-status=failure

# Drill into a specific result
npx checkly checks get 12345 --result=abc-123

# View an error group
npx checkly checks get 12345 --error-group=err-456

# Get check details as JSON
npx checkly checks get 12345 --output=json

# Show more results
npx checkly checks get 12345 --results-limit=25

`checkly checks stats`

Show analytics stats for your checks. View availability, response times, and other metrics across multiple checks at once, with filtering by tag, type, or name. Usage:

Terminal

npx checkly checks stats [checkIds...] [options]

Arguments:

Argument	Description
`checkIds`	One or more check IDs to get stats for. If omitted, stats are shown for all checks.

Options:

Option	Required	Description
`--range, -r`	-	Time range for stats: `last24Hours`, `last7Days`, `thisWeek`, `lastWeek`, `lastMonth`. Default: `last24Hours`.
`--limit, -l`	-	Number of checks to return (1-100). Default: `25`.
`--page, -p`	-	Page number. Default: `1`.
`--search, -s`	-	Filter checks by name (case-insensitive).
`--tag, -t`	-	Filter by tag. Can be specified multiple times.
`--type`	-	Filter by check type.
`--output, -o`	-	Output format: `table`, `json`, or `md`. Default: `table`.

Stats Options

--range, -r

string

default:"last24Hours"

Time range for the analytics stats. Available ranges: last24Hours, last7Days, thisWeek, lastWeek, lastMonth.Usage:

Terminal

npx checkly checks stats --range=last7Days
npx checkly checks stats -r lastMonth

--limit, -l

number

default:"25"

Number of checks to return per page, between 1 and 100.Usage:

Terminal

npx checkly checks stats --limit=50
npx checkly checks stats -l 10

--page, -p

number

default:"1"

Page number for paginated results.Usage:

Terminal

npx checkly checks stats --page=2
npx checkly checks stats -p 3

--search, -s

string

Filter checks by name using a case-insensitive search.Usage:

Terminal

npx checkly checks stats --search="homepage"
npx checkly checks stats -s "api"

--tag, -t

string

Filter checks by tag. Specify multiple times to filter by multiple tags.Usage:

Terminal

npx checkly checks stats --tag=production
npx checkly checks stats -t production -t critical

--type

string

Filter checks by type. Available types: API, BROWSER, MULTI_STEP, HEARTBEAT, PLAYWRIGHT, TCP, DNS, ICMP, URL.Usage:

Terminal

npx checkly checks stats --type=API
npx checkly checks stats --type=BROWSER

--output, -o

string

default:"table"

Set the output format. Use json for programmatic access or md for markdown.Usage:

Terminal

npx checkly checks stats --output=json
npx checkly checks stats -o md

Stats Examples

Terminal

# Show stats for all checks (last 24 hours)
npx checkly checks stats

# Show stats for specific checks
npx checkly checks stats 12345 67890

# Show stats for the last 7 days
npx checkly checks stats --range=last7Days

# Filter by tag and type
npx checkly checks stats --tag=production --type=API

# Search by name and output as JSON
npx checkly checks stats --search="homepage" --output=json

# Page through results
npx checkly checks stats --limit=10 --page=2

`checkly checks delete`

The checkly checks delete command is only available since CLI v8.8.0.

Delete a check by ID. By default, the command shows the check to be deleted and prompts for confirmation before proceeding.

Checks managed by a CLI project are recreated on the next checkly deploy. To permanently remove a project-managed check, delete it from your project code instead of using this command.

Usage:

Terminal

npx checkly checks delete <id> [options]

Arguments:

Argument	Description
`id`	The ID of the check to delete.

Options:

Option	Required	Description
`--force, -f`	-	Skip the confirmation prompt.
`--dry-run`	-	Preview what would happen without deleting the check.

Delete Options

--force, -f

boolean

default:"false"

Skip the confirmation prompt and delete the check immediately. Useful in scripts and CI.Usage:

Terminal

npx checkly checks delete 12345 --force
npx checkly checks delete 12345 -f

--dry-run

boolean

default:"false"

Preview the deletion without making any changes. Shows the check that would be deleted.Usage:

Terminal

npx checkly checks delete 12345 --dry-run

Delete Examples

Terminal

# Delete a check with a confirmation prompt
npx checkly checks delete 12345

# Preview the deletion without making changes
npx checkly checks delete 12345 --dry-run

# Delete without a confirmation prompt
npx checkly checks delete 12345 --force

checkly status-pages - List and inspect status pages
checkly trigger - Trigger checks on-demand
checkly whoami - Display current account information

​Usage

​Subcommands

​checkly checks list

​List Options

​List Examples

​checkly checks get

​Get Options

​Get Examples

​checkly checks stats

​Stats Options

​Stats Examples

​checkly checks delete

​Delete Options

​Delete Examples

​Related Commands

Usage

Subcommands

`checkly checks list`

List Options

List Examples

`checkly checks get`

Get Options

Get Examples

`checkly checks stats`

Stats Options

Stats Examples

`checkly checks delete`

Delete Options

Delete Examples

Related Commands