# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pirsch Conversion Goals API
  version: 1.0.0
extends: openapi/pirsch-conversion-goals-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: 5
- target: $.paths['/goal'].get
  update:
    x-apievangelist-phrasing:
      intent: List a domain's conversion goals
      effect: read
      questions:
      - Which conversion goals have I configured for my site?
      - Can I search my conversion goals by name?
      instructions:
      - text: List the conversion goals for domain {id}.
        slots:
          id: query.id
      - text: Find conversion goals on domain {id} matching {search}.
        slots:
          id: query.id
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goal'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing conversion goal
      effect: write
      questions:
      - How do I change the path pattern on a conversion goal I already created?
      - Can I turn on email alerts when an existing goal is reached?
      instructions:
      - text: Rename conversion goal {id} on domain {domain_id} to {name}.
        slots:
          id: requestBody.id
          domain_id: requestBody.domain_id
          name: requestBody.name
      - text: Update goal {id} on domain {domain_id} named {name} to match the path pattern {path_pattern}.
        slots:
          id: requestBody.id
          domain_id: requestBody.domain_id
          name: requestBody.name
          path_pattern: requestBody.path_pattern
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goal'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a conversion goal
      effect: write
      questions:
      - How do I track a conversion when visitors reach my thank-you page?
      - Can a new goal be triggered by a custom event instead of a page path?
      - Is it possible to get an email when a new conversion goal is first reached?
      instructions:
      - text: Create a conversion goal {name} on domain {domain_id} for pages matching {path_pattern}.
        slots:
          name: requestBody.name
          domain_id: requestBody.domain_id
          path_pattern: requestBody.path_pattern
      - text: Add a goal {name} on domain {domain_id} that counts the event {event_name}.
        slots:
          name: requestBody.name
          domain_id: requestBody.domain_id
          event_name: requestBody.event_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goal'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a conversion goal
      effect: destructive
      questions:
      - How can I remove a conversion goal I no longer need?
      - Can I delete a goal without losing my other analytics data?
      instructions:
      - text: Delete conversion goal {id}.
        slots:
          id: query.id
      - text: Remove the goal {id} from my site.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/goal/regex'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a goal regex against a sample path
      effect: read
      questions:
      - Can I check whether my goal's regex matches a URL before saving it?
      - What's a quick way to test a conversion goal pattern against a sample string?
      instructions:
      - text: Test the regex {regex} against {sample}.
        slots:
          regex: requestBody.regex
          sample: requestBody.sample
      - text: Check whether goal pattern {regex} matches the path {sample}.
        slots:
          regex: requestBody.regex
          sample: requestBody.sample
      method: generated
      generated: '2026-10-01'