Skip to main content
GET
List all available reporting metrics.

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<uuid>

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

Query Parameters

checkType
enum<string>
required
Available options:
AGENTIC,
API,
BROWSER,
HEARTBEAT,
ICMP,
MULTI_STEP,
TCP,
PLAYWRIGHT,
TRACEROUTE,
URL,
DNS,
SSL,
GRPC

Response

Successful

name
string
required
unit
enum<string>
required
Available options:
milliseconds,
score,
count,
percentage
label
string
required
aggregated
boolean
required
type
enum<string>
Available options:
Array,
Int,
Integer,
Float,
String