v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Reporting

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

Query parameters

fromstring date

Custom start time of reporting window in unix timestamp format. Setting a custom "from" timestamp overrides the use of any "quickRange".

tostring date

Custom end time of reporting window in unix timestamp format. Setting a custom "to" timestamp overrides the use of any "quickRange".

Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp.

filterByTagsstring[]

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

[
  "production"
]

deactivatedboolean nullable

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'day' | 'week' | 'month'

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.

timezonestring

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

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.

Headers

x-checkly-accountstring

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

Response

Successful

namestring required

Check name.

checkIdstring required

Check ID.

checkTypestring required

Check type.

deactivatedboolean required

Check deactivated.

tagsstring[] required

Check tags.

Example response

[
  {
    "name": "API Check",
    "checkId": "d2881e09-411b-4c8d-84b8-fe05fbca80b6",
    "checkType": "API",
    "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"
      }
    ]
  }
]