Skip to content

Document reporting API granularity and timezones#443

Merged
thebiglabasky merged 2 commits into
mainfrom
herve/document-reporting-granularity
Jul 15, 2026
Merged

Document reporting API granularity and timezones#443
thebiglabasky merged 2 commits into
mainfrom
herve/document-reporting-granularity

Conversation

@thebiglabasky

Copy link
Copy Markdown
Contributor

Summary

  • document generally available day, week, and month reporting buckets and the aggregates response shape
  • explain timezone defaults, IANA timezone support, DST-aware calendar boundaries, query limits, and successRatio precision
  • refresh only the generated /v1/reporting OpenAPI path and reporting aggregate schemas

This aligns the public API reference with the merged backend behavior in https://github.com/checkly/monorepo/pull/3025.

Verification

  • npx mint openapi-check api-reference/openapi.json
  • python3 .github/scripts/check_redirect_destinations.py
  • python3 .github/scripts/check_frontmatter.py
  • npm run generate-sitemap and confirmed no sitemap diff
  • npx mint broken-links
  • focused assertions for the reporting contract and encoded request example

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Jul 15, 2026, 2:39 PM

@thebiglabasky thebiglabasky marked this pull request as ready for review July 15, 2026 14:48
@thebiglabasky thebiglabasky enabled auto-merge (squash) July 15, 2026 14:50
@thebiglabasky thebiglabasky merged commit 6bf11da into main Jul 15, 2026
5 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant