Swetrix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Swetrix Statistics Custom Events API

2 actions 2 updates phrasing extends openapi/swetrix-custom-events-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 2

$.info
$.paths['/v1/log/custom-events'].get

OpenAPI Overlay

Raw ↑
# 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 Custom Events API
  version: 1.0.0
extends: openapi/swetrix-custom-events-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/log/custom-events'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart custom event counts over time
      effect: read
      questions:
      - How many times did my signup custom event fire each day this month?
      - Can I compare trends for several custom events in one Swetrix query?
      - Which time buckets can custom event counts be grouped by?
      instructions:
      - text: Get counts for custom events {customEvents} in project {pid} over {period} grouped by {timeBucket}.
        slots:
          customEvents: query.customEvents
          pid: query.pid
          period: query.period
          timeBucket: query.timeBucket
      - text: Show the trend of custom events {customEvents} for project {pid} from {from} to {to}, bucketed by {timeBucket}, for period {period}.
        slots:
          customEvents: query.customEvents
          pid: query.pid
          from: query.from
          to: query.to
          timeBucket: query.timeBucket
          period: query.period
      method: generated
      generated: '2026-09-26'