Skip to content

Document reporting API granularity and timezones #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thebiglabasky merged 2 commits into from
Jul 15, 2026
Merged

Document reporting API granularity and timezones #443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8f42fd
docs(api): document reporting granularity
thebiglabasky Jul 15, 2026
f973508
docs(api): link IANA timezones
thebiglabasky Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 15 additions & 1 deletion ...ng/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
---
openapi: get /v1/reporting
canonical: 'https://www.checklyhq.com/docs/api-reference/reporting/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups/'
---
---

## 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`.

```http
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](https://data.iana.org/time-zones/tzdb/zone1970.tab) 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.
Loading