Pirsch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pirsch Funnels API

4 actions 4 updates phrasing extends openapi/pirsch-funnels-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Pirsch's API. It is a proposal applied on top of the contract, not a document Pirsch publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/funnel'].get
$.paths['/funnel'].post
$.paths['/funnel'].delete

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 Pirsch Funnels API
  version: 1.0.0
extends: openapi/pirsch-funnels-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/funnel'].get
  update:
    x-apievangelist-phrasing:
      intent: List a domain's funnels
      effect: read
      questions:
      - Which funnels have I defined for my site?
      - Can I search my funnels by name?
      instructions:
      - text: List the funnels for domain {id}.
        slots:
          id: query.id
      - text: Find funnels on domain {id} matching {search}.
        slots:
          id: query.id
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/funnel'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or edit a funnel's steps
      effect: write
      questions:
      - How do I build a signup funnel from landing page to confirmation?
      - Can I change the steps of a funnel I already created?
      instructions:
      - text: Create a funnel {name} on domain {domain_id} with steps {steps}.
        slots:
          name: requestBody.name
          domain_id: requestBody.domain_id
          steps: requestBody.steps
      - text: Update funnel {id} on domain {domain_id} to be named {name} with steps {steps}.
        slots:
          id: requestBody.id
          domain_id: requestBody.domain_id
          name: requestBody.name
          steps: requestBody.steps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/funnel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a funnel
      effect: destructive
      questions:
      - How can I remove a funnel I no longer use?
      - Does deleting a funnel affect my other site statistics?
      instructions:
      - text: Delete funnel {id}.
        slots:
          id: query.id
      - text: Remove the funnel {id} from my site.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'