Swetrix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Swetrix Statistics Performance API

3 actions 3 updates phrasing extends openapi/swetrix-performance-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/log/performance'].get

$.paths['/v1/log/performance/birdseye'].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 Swetrix Statistics Performance API
  version: 1.0.0
extends: openapi/swetrix-performance-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: 2
- target: $.paths['/v1/log/performance'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart page load and timing metrics
      effect: read
      questions:
      - What's the p95 time to first byte on my site this month?
      - Can I see DNS, TLS and render timings bucketed over time?
      - Which statistical measures can performance timings be aggregated with?
      instructions:
      - text: Get performance timings for project {pid} over {period} by {timeBucket}.
        slots:
          pid: query.pid
          period: query.period
          timeBucket: query.timeBucket
      - text: Show {measure} page load metrics for project {pid}, bucketed by {timeBucket}, for {period}.
        slots:
          measure: query.measure
          pid: query.pid
          timeBucket: query.timeBucket
          period: query.period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/log/performance/birdseye'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare performance against the previous period
      effect: read
      questions:
      - Did my sites get faster or slower compared with the previous period?
      - Can I get a performance summary across several projects at once?
      instructions:
      - text: Summarize performance for projects {pids} over {period} versus the previous period.
        slots:
          pids: query.pids
          period: query.period
      - text: Give me the birdseye performance comparison for {period}.
        slots:
          period: query.period
      method: generated
      generated: '2026-09-26'