Checkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkly Public Reporting API

2 actions 2 updates phrasing extends openapi/checkly-reporting-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Checkly's API. It is a proposal applied on top of the contract, not a document Checkly publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/reporting'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Reporting API
  version: 1.0.0
extends: openapi/checkly-reporting-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1/reporting'].get
  update:
    x-apievangelist-phrasing:
      intent: Report aggregate stats for checks
      effect: read
      questions:
      - What was the availability of all my checks last month?
      - Can I get weekly buckets of check statistics in my timezone?
      - Can a report cover only checks with certain tags?
      instructions:
      - text: Generate a check report for {quickRange}.
        slots:
          quickRange: query.quickRange
      - text: Report stats for checks tagged {filterByTags} over {quickRange}.
        slots:
          filterByTags: query.filterByTags
          quickRange: query.quickRange
      - text: Build a report split by {granularity} in timezone {timezone} from {from} to {to}.
        slots:
          granularity: query.granularity
          timezone: query.timezone
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'