# 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 Analytics API
  version: 1.0.0
extends: openapi/checkly-analytics-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: 12
- target: $.paths['/v1/analytics/api-checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for an API check
      effect: read
      questions:
      - What was the p99 DNS time and availability of my API check last week?
      - Can I break down an API check's response-time metrics by location?
      - Which timing phases can I pull for an API check over a custom date range?
      instructions:
      - text: Show {metrics} for API check {id} over the {quickRange} window.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Pull API check {id} {metrics} aggregated every {aggregationInterval} minutes, grouped by {groupBy}.
        slots:
          id: path.id
          metrics: query.metrics
          aggregationInterval: query.aggregationInterval
          groupBy: query.groupBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/browser-checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for a browser check
      effect: read
      questions:
      - How many console errors did my browser check hit on average this month?
      - Can I get the p99 First Contentful Paint and TTFB for a browser check?
      - What web vitals does the analytics endpoint report for browser checks?
      instructions:
      - text: Show {metrics} for browser check {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Get failing-run {metrics} for browser check {id} filtered by status {filterByStatus}.
        slots:
          metrics: query.metrics
          id: path.id
          filterByStatus: query.filterByStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/checks'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize analytics for several checks at once
      effect: read
      questions:
      - Can I get availability and response times for a batch of checks in one call?
      - How do I compare uptime across a handful of my Checkly checks side by side?
      - What happens when one of the checks I ask about has no data in the time range?
      instructions:
      - text: Summarize availability and latency for checks {checkIds} over {quickRange}.
        slots:
          checkIds: requestBody.checkIds
          quickRange: query.quickRange
      - text: Give me an analytics summary covering checks {checkIds}.
        slots:
          checkIds: requestBody.checkIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/dns/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for a DNS monitor
      effect: read
      questions:
      - What's the p95 total DNS query time for my DNS monitor today?
      - Can I see how available my DNS monitor was over the last 30 days?
      - Which metrics can I request for a DNS monitor?
      instructions:
      - text: Show {metrics} for DNS monitor {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Pull DNS monitor {id} {metrics} between {from} and {to}.
        slots:
          id: path.id
          metrics: query.metrics
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/heartbeat-checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get availability metrics for a heartbeat check
      effect: read
      questions:
      - How often did my cron job's heartbeat ping arrive late or early?
      - What availability did my heartbeat check have over the past week?
      - Can I filter heartbeat check metrics to only late pings?
      instructions:
      - text: Show {metrics} for heartbeat check {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Get heartbeat check {id} {metrics} for pings with status {filterByStatus}.
        slots:
          id: path.id
          metrics: query.metrics
          filterByStatus: query.filterByStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/icmp/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get latency and packet loss for an ICMP monitor
      effect: read
      questions:
      - What packet loss percentage did my ICMP ping monitor see yesterday?
      - Can I get p99 ping latency for an ICMP monitor over a custom window?
      - Which latency metrics are available for ICMP monitors?
      instructions:
      - text: Show {metrics} for ICMP monitor {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Pull ICMP monitor {id} {metrics} from {from} to {to}, grouped by {groupBy}.
        slots:
          id: path.id
          metrics: query.metrics
          groupBy: query.groupBy
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List reporting metrics available per check type
      effect: read
      questions:
      - Which metric names can I request from Checkly analytics for a given check type?
      - What reporting metrics exist for browser checks versus API checks?
      instructions:
      - text: List the analytics metrics available for {checkType} checks.
        slots:
          checkType: query.checkType
      - text: Tell me every reporting metric name I can query for check type {checkType}.
        slots:
          checkType: query.checkType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/multistep-checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for a multistep check
      effect: read
      questions:
      - How did my multistep check perform over the last 24 hours?
      - Can I get aggregated or raw metrics for a multistep API flow check?
      - Is there a rate limit on pulling multistep check analytics?
      instructions:
      - text: Show {metrics} for multistep check {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Get multistep check {id} {metrics} aggregated every {aggregationInterval} minutes.
        slots:
          id: path.id
          metrics: query.metrics
          aggregationInterval: query.aggregationInterval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/playwright-checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for a Playwright check
      effect: read
      questions:
      - What's the availability of my Playwright check suite this month?
      - Can I see Playwright check metrics split by location?
      - Which metrics can I request for a Playwright check?
      instructions:
      - text: Show {metrics} for Playwright check {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Pull Playwright check {id} {metrics} grouped by {groupBy}.
        slots:
          id: path.id
          metrics: query.metrics
          groupBy: query.groupBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/ssl/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get TLS handshake metrics for an SSL monitor
      effect: read
      questions:
      - What's the p95 TLS handshake time for my SSL monitor?
      - How available was my SSL certificate monitor over the last week?
      - Which metrics does an SSL monitor report?
      instructions:
      - text: Show {metrics} for SSL monitor {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Get SSL monitor {id} {metrics} between {from} and {to}.
        slots:
          id: path.id
          metrics: query.metrics
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/tcp-checks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for a TCP check
      effect: read
      questions:
      - What are the p99 connection phase timings for my TCP check?
      - Can I get TCP check availability for a custom time window?
      - Which metrics are reported for TCP checks?
      instructions:
      - text: Show {metrics} for TCP check {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Pull TCP check {id} {metrics} aggregated every {aggregationInterval} minutes.
        slots:
          id: path.id
          metrics: query.metrics
          aggregationInterval: query.aggregationInterval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/analytics/url-monitors/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance metrics for a URL monitor
      effect: read
      questions:
      - How available was my URL monitor over the last 7 days?
      - Can I get p95 response time for a URL monitor split by region?
      - Which metrics can I request for a URL monitor?
      instructions:
      - text: Show {metrics} for URL monitor {id} over {quickRange}.
        slots:
          metrics: query.metrics
          id: path.id
          quickRange: query.quickRange
      - text: Get URL monitor {id} {metrics} for runs with status {filterByStatus}.
        slots:
          id: path.id
          metrics: query.metrics
          filterByStatus: query.filterByStatus
      method: generated
      generated: '2026-09-26'