Generate report

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

GET /v1/reporting

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

import requests

url = "https://api.checklyhq.com/v1/reporting"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.checklyhq.com/v1/reporting', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v1/reporting",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checklyhq.com/v1/reporting"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.checklyhq.com/v1/reporting")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v1/reporting")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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
    },
    "aggregates": [
      {
        "successRatio": 50,
        "avg": 100,
        "p95": 200,
        "p99": 100,
        "from": "2026-06-01T00:00:00.000Z",
        "to": "2026-07-01T00:00:00.000Z"
      }
    ]
  }
]

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Bad Token",
  "attributes": {}
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden"
}

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too Many Requests",
  "attributes": {}
}

Generate bucketed reports

Granular reporting is generally available. Set granularity to day, week, or month to return per-bucket results in aggregates instead of a single result in aggregate.

GET /v1/reporting?from=<unix>&to=<unix>&granularity=day&timezone=America%2FNew_York

You can set timezone only when you set granularity. It accepts named IANA time zones such as America/New_York, but not UTC offset identifiers such as +05:00. If you omit timezone, bucket boundaries use UTC.

Bucket boundaries follow calendar boundaries in the selected time zone. Daily buckets can therefore span 23 or 25 hours around daylight saving time transitions.

Granular queries support reporting windows of up to 400 days and up to 120 buckets. The successRatio field can contain up to four decimal places in both granular and non-granular reports.

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.

granularity · enum<string>

Split the reporting window into calendar buckets and return one aggregate per bucket in "aggregates" instead of a single "aggregate". Bucket boundaries use UTC unless "timezone" is set. The window may span at most 400 days and at most 120 buckets at the chosen granularity.

Available options: day, week, month

timezone · string

Named IANA time zone used for calendar bucket boundaries when "granularity" is set. UTC offset identifiers such as "+05:00" are not accepted. Defaults to UTC.

Example:

"America/New_York"

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

Whole-window aggregate. Absent when "granularity" is used.

Show child attributes

aggregates · object[]

Per-bucket aggregates, ascending by bucket start. Only present when "granularity" is used. Buckets without any check runs are omitted.

Show child attributes