---
title: "Generates a report with aggregate statistics for checks and check groups."
method: GET
path: "/v1/reporting"
tags: ["Reporting"]
---

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

`GET /v1/reporting`

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

## 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` 'last24Hrs' | 'last7Days' | 'last30Days' | 'thisWeek' | 'thisMonth' | 'lastWeek' | 'lastMonth' — Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom "to" and "from" timestamp.
- `filterByTags` string[] — Use tags to filter the checks you want to see in your report.
- `deactivated` boolean, 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.
- `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.

## Headers

- `x-checkly-account` string — Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

## Response `200`

Successful

- Reporting[]
  - `name` string, required — Check name.
  - `checkId` string, required — Check ID.
  - `checkType` string, required — Check type.
  - `deactivated` boolean, required — Check deactivated.
  - `tags` string[], required — Check tags.
  - `aggregate` ReportingAggregate — Whole-window aggregate. Absent when "granularity" is used.
    - `successRatio` number, required — Success ratio of the check over selected date range, rounded to four decimal places. Percentage is in decimal form.
    - `avg` number, required — Average response time of the check over selected date range in milliseconds.
    - `p95` number, required — P95 response time of the check over selected date range in milliseconds.
    - `p99` number, required — P99 response time of the check over selected date range in milliseconds.
  - `aggregates` ReportingBucketAggregate[] — Per-bucket aggregates, ascending by bucket start. Only present when "granularity" is used. Buckets without any check runs are omitted.
    - `successRatio` number, required — Success ratio of the check over selected date range, rounded to four decimal places. Percentage is in decimal form.
    - `avg` number, required — Average response time of the check over selected date range in milliseconds.
    - `p95` number, required — P95 response time of the check over selected date range in milliseconds.
    - `p99` number, required — P99 response time of the check over selected date range in milliseconds.
    - `from` string, required — Start of the bucket, clamped to the requested window.
    - `to` string, required — End of the bucket, clamped to the requested window.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/checklyhq/apis/checkly-public-api.md) · [All operations](https://skmtc.net/checklyhq/apis/checkly-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/checklyhq/checkly-public-api/revisions/9e903da4f3da/schema)