# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pirsch Email Reports API
  version: 1.0.0
extends: openapi/pirsch-email-reports-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: 4
- target: $.paths['/report'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled email reports for a domain
      effect: read
      questions:
      - Which scheduled email reports are set up for my site?
      - Who receives analytics reports by email for a domain?
      instructions:
      - text: List the email reports for domain {id}.
        slots:
          id: query.id
      - text: Show every scheduled analytics email configured on domain {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/report'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an email report's schedule
      effect: write
      questions:
      - Can I change an existing email report from weekly to monthly?
      - How do I update where the links in an existing report point?
      instructions:
      - text: Change email report {id} to send every {interval} weeks.
        slots:
          id: requestBody.id
          interval: requestBody.interval
      - text: Make the links in email report {id} point to {link_to}.
        slots:
          id: requestBody.id
          link_to: requestBody.link_to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/report'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an analytics email report
      effect: write
      questions:
      - How do I get my site's statistics emailed to my team every week?
      - Can I schedule a monthly analytics report to several addresses?
      - Is there a way to set a reply-to address on a new email report?
      instructions:
      - text: Email a report for domain {domain_id} to {emails} every {interval} weeks.
        slots:
          domain_id: requestBody.domain_id
          emails: requestBody.emails
          interval: requestBody.interval
      - text: Schedule a report for domain {domain_id} to {emails} at interval {interval} starting {start_date}.
        slots:
          domain_id: requestBody.domain_id
          emails: requestBody.emails
          interval: requestBody.interval
          start_date: requestBody.start_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/report'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled email report
      effect: destructive
      questions:
      - How do I stop an analytics email report from being sent?
      - Can I delete one scheduled report and keep the others?
      instructions:
      - text: Delete email report {id}.
        slots:
          id: query.id
      - text: Stop sending the scheduled report {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'