# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Matomo Reporting API for plugin Scheduled Reports API
  version: 1.0.0
extends: openapi/matomo-scheduled-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: 6
- target: $.paths['/index.php?module=API&method=ScheduledReports.addReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Schedule a new email report
      effect: write
      questions:
      - How do I get a weekly PDF of my analytics emailed to me automatically?
      - Can a scheduled report be sent at a specific hour of the day?
      - Which formats can a scheduled report be delivered in?
      instructions:
      - text: Schedule a {period} {reportFormat} report {description} for site {idSite} at hour {hour} via {reportType}, covering {reports} with {parameters}.
        slots:
          period: query.period
          reportFormat: query.reportFormat
          description: query.description
          idSite: query.idSite
          hour: query.hour
          reportType: query.reportType
          reports: query.reports
          parameters: query.parameters
      - text: Create a new scheduled report of {reports} on site {idSite} for segment {idSegment}, sent {period} at hour {hour}.
        slots:
          reports: query.reports
          idSite: query.idSite
          idSegment: query.idSegment
          period: query.period
          hour: query.hour
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ScheduledReports.updateReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Update a scheduled report
      effect: write
      questions:
      - How do I change the delivery time of a report I already scheduled?
      - Can I switch an existing scheduled report from PDF to HTML?
      instructions:
      - text: Update scheduled report {idReport} on site {idSite} to send {reports} {period} at hour {hour} as {reportFormat}.
        slots:
          idReport: query.idReport
          idSite: query.idSite
          reports: query.reports
          period: query.period
          hour: query.hour
          reportFormat: query.reportFormat
      - text: 'Change existing report {idReport} on site {idSite}: description {description}, delivery {reportType}, parameters {parameters}.'
        slots:
          idReport: query.idReport
          idSite: query.idSite
          description: query.description
          reportType: query.reportType
          parameters: query.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ScheduledReports.deleteReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled report
      effect: destructive
      questions:
      - How do I stop a scheduled email report from being sent?
      - Is a deleted scheduled report actually removed or just flagged?
      instructions:
      - text: Delete scheduled report {idReport}.
        slots:
          idReport: query.idReport
      - text: Stop and remove the scheduled report {idReport}.
        slots:
          idReport: query.idReport
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ScheduledReports.getReports'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled reports
      effect: read
      questions:
      - Which email reports are scheduled for my website?
      - Can I filter scheduled reports by period or segment?
      instructions:
      - text: List the scheduled reports for site {idSite}.
        slots:
          idSite: query.idSite
      - text: Show scheduled reports on site {idSite} that run {period} for segment {idSegment}.
        slots:
          idSite: query.idSite
          period: query.period
          idSegment: query.idSegment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ScheduledReports.generateReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a scheduled report's output
      effect: read
      questions:
      - Can I produce the contents of a scheduled report for a past date without emailing it?
      - Is it possible to render a scheduled report in a different language?
      instructions:
      - text: Generate scheduled report {idReport} for {date}.
        slots:
          idReport: query.idReport
          date: query.date
      - text: Render report {idReport} for {date} in language {language} as {reportFormat}.
        slots:
          idReport: query.idReport
          date: query.date
          language: query.language
          reportFormat: query.reportFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ScheduledReports.sendReport'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a scheduled report immediately
      effect: write
      questions:
      - How do I send a scheduled report right now instead of waiting for its next run?
      - Can I force a report to be resent for a specific date?
      instructions:
      - text: Send scheduled report {idReport} now.
        slots:
          idReport: query.idReport
      - text: Email report {idReport} immediately for {date}, forcing delivery ({force}).
        slots:
          idReport: query.idReport
          date: query.date
          force: query.force
      method: generated
      generated: '2026-10-01'