# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Statistics API
  version: 1.0.0
extends: openapi/svix-statistics-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: 4
- target: $.paths['/api/v1/stats/usage/event-types'].put
  update:
    x-apievangelist-phrasing:
      intent: Calculate event type subscriptions across all apps
      effect: write
      questions:
      - Which event types is each of my applications explicitly subscribed to?
      - Can I find out which apps have a catch-all endpoint that receives every event?
      instructions:
      - text: Start a background task to aggregate subscribed event types for every app in the organization.
      - text: Work out which event types each application subscribes to and poll the task for the result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stats/usage/app'].post
  update:
    x-apievangelist-phrasing:
      intent: Calculate message attempt counts for all apps
      effect: write
      questions:
      - How many message destinations did each application use over a billing period?
      - Can I aggregate usage for only a few specific apps?
      instructions:
      - text: Start a background task counting message destinations for all apps from {since} to {until}.
        slots:
          since: requestBody.since
          until: requestBody.until
      - text: Aggregate usage stats for apps {appIds} between {since} and {until}.
        slots:
          appIds: requestBody.appIds
          since: requestBody.since
          until: requestBody.until
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stats/endpoint/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count active and disabled endpoints
      effect: read
      questions:
      - How many active and disabled endpoints are in my environment?
      - Can I count endpoints without the ones pointing at play.svix.com?
      instructions:
      - text: Count active and disabled endpoints across the environment.
      - text: 'Count endpoints in the environment, excluding Svix Play URLs: {exclude_svix_play}.'
        slots:
          exclude_svix_play: query.exclude_svix_play
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stats/app/{app_id}/attempt'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app's attempt stats grouped by period
      effect: read
      questions:
      - How did one application's delivery attempts trend day by day?
      - Can I group an app's attempt statistics by a chosen period?
      instructions:
      - text: Show attempt statistics for app {app_id} aggregated by {period}.
        slots:
          app_id: path.app_id
          period: query.period
      - text: Get app {app_id}'s attempt trend from {startDate} to {endDate} for {event_types}.
        slots:
          app_id: path.app_id
          startDate: query.startDate
          endDate: query.endDate
          event_types: query.event_types
      method: generated
      generated: '2026-09-26'