GET
/
v1
/
private-locations
/
{id}
/
metrics
Get private location health metrics from a window of time.
curl --request GET \
  --url https://api.checklyhq.com/v1/private-locations/{id}/metrics \
  --header 'Authorization: <api-key>'
{
  "timestamps": [
    "2023-11-07T05:31:56Z"
  ],
  "queueSize": [
    123
  ],
  "oldestScheduledCheckRun": [
    123
  ]
}

​
Overview

The Get Private Location Metrics endpoint provides performance and health metrics for a specific private location, including agent status, check execution statistics, and connectivity information. Common Use Cases:
  • Agent Performance Monitoring
  • Health Status Verification
  • Capacity Planning
  • Troubleshooting
Private location metrics help monitor agent performance, connectivity, and resource utilization to ensure reliable monitoring from your infrastructure.

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

Select metrics beginning with this UNIX timestamp. Must be less than 15 days ago.

​
to
string<date>
required

Select metrics up to this UNIX timestamp.

Response

Successful

​
timestamps
string<date-time>[]
​
queueSize
number[]
​
oldestScheduledCheckRun
number[]