# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Swetrix Funnels API
  version: 1.0.0
extends: openapi/swetrix-funnels-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: 5
- target: $.paths['/v1/project/funnels/{pid}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's saved funnels
      effect: read
      questions:
      - Which conversion funnels have I already saved for this project?
      - Can I see every saved funnel definition in a project?
      instructions:
      - text: List the saved funnels for project {pid}.
        slots:
          pid: path.pid
      - text: Show all funnel definitions in project {pid}.
        slots:
          pid: path.pid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/funnel'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new conversion funnel
      effect: write
      questions:
      - How do I define a signup funnel as a sequence of pages?
      - Can I save a funnel so I don't have to re-enter the page steps each time?
      instructions:
      - text: Create a funnel named {name} in project {pid} with steps {steps}.
        slots:
          name: requestBody.name
          pid: requestBody.pid
          steps: requestBody.steps
      - text: Save funnel {name} for project {pid} tracking pages {steps} in order.
        slots:
          name: requestBody.name
          pid: requestBody.pid
          steps: requestBody.steps
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/funnel'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a saved funnel or change its steps
      effect: write
      questions:
      - Can I add or reorder pages in a funnel I already saved?
      - Is it possible to rename an existing funnel?
      instructions:
      - text: Change the steps of saved funnel {id} in project {pid} to {steps}.
        slots:
          id: requestBody.id
          pid: requestBody.pid
          steps: requestBody.steps
      - text: Rename saved funnel {id} in project {pid} to {name}.
        slots:
          id: requestBody.id
          pid: requestBody.pid
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/funnel/{id}/{pid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved funnel
      effect: destructive
      questions:
      - How do I remove a funnel I no longer use?
      - Can I delete one saved funnel without affecting the others?
      instructions:
      - text: Delete funnel {id} from project {pid}.
        slots:
          id: path.id
          pid: path.pid
      - text: Remove saved funnel {id} in project {pid}.
        slots:
          id: path.id
          pid: path.pid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/log/funnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Analyze conversion and drop-off through a funnel
      effect: read
      questions:
      - Where do visitors drop off between my homepage, signup and dashboard?
      - What percentage of people convert at each step of my saved funnel?
      - Can I run a funnel analysis on an ad-hoc list of pages without saving it first?
      instructions:
      - text: Show conversion and drop-off for saved funnel {funnelId} in project {pid} over {period}.
        slots:
          funnelId: query.funnelId
          pid: query.pid
          period: query.period
      - text: Analyze conversion through pages {pages} in project {pid} for {period}.
        slots:
          pages: query.pages
          pid: query.pid
          period: query.period
      method: generated
      generated: '2026-09-26'