Generates a report with aggregate statistics for checks and check groups.

Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window.

GET /v1/reporting

Try it

Generates a report with aggregate statistics for checks and check groups.

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/reporting \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "name": "API Check",
    "checkId": "d2881e09-411b-4c8d-84b8-fe05fbca80b6",
    "checkType": "API",
    "deactivated": false,
    "tags": [
      "production"
    ],
    "aggregate": {
      "successRatio": 50,
      "avg": 100,
      "p95": 200,
      "p99": 100
    }
  }
]

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

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: last24Hrs

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: last24Hrs, last7Days, last30Days, thisWeek, thisMonth, lastWeek, lastMonth

filterByTags · string[]

Use tags to filter the checks you want to see in your report.

Example:

["production"]

deactivated · boolean | null

Filter checks by activated status. When set to true, only deactivated checks are returned. When set to false, only activated checks are returned. When omitted, all checks are returned.

Response

200

application/json

Successful

name · string · required

Check name.

Example:

"API Check"

checkId · string · required

Check ID.

Example:

"d2881e09-411b-4c8d-84b8-fe05fbca80b6"

checkType · string · required

Check type.

Example:

"API"

deactivated · boolean · default: false · required

Check deactivated.

tags · string[] · required

Check tags.

Example:

["production"]

aggregate · object

Show child attributes

aggregate. successRatio · number · required

Success ratio of the check over selected date range. Percentage is in decimal form.

Required range: x >= 0

Example:

50

aggregate. avg · number · required

Average response time of the check over selected date range in milliseconds.

Required range: x >= 0

Example:

100

aggregate. p95 · number · required

P95 response time of the check over selected date range in milliseconds.

Required range: x >= 0

Example:

200

aggregate. p99 · number · required

P99 response time of the check over selected date range in milliseconds.

Required range: x >= 0

Example:

100