# 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 Multi Sites API
  version: 1.0.0
extends: openapi/matomo-multisites-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['/index.php?module=API&method=MultiSites.getAll'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare visits and revenue across all sites
      effect: read
      questions:
      - Which of my websites got the most visits and revenue this month?
      - How have visits changed across every site compared to the previous period?
      - Can I filter the all-websites report to sites whose name matches a pattern?
      instructions:
      - text: Show visits, actions and revenue for all sites for {period} {date}.
        slots:
          period: query.period
          date: query.date
      - text: Compare all websites matching {pattern} for {period} {date}.
        slots:
          pattern: query.pattern
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MultiSites.getOne'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all-websites metrics for one site
      effect: read
      questions:
      - What are one website's total visits, actions and revenue with their trend?
      - Can I pull the all-websites dashboard row for a single site?
      instructions:
      - text: Get the multi-site metrics for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show the visits and revenue evolution for website {idSite} on {date}.
        slots:
          idSite: query.idSite
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=MultiSites.getAllWithGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the grouped all-websites dashboard data
      effect: read
      questions:
      - Can I get the all-websites dashboard data grouped the way the widget shows it?
      - Is there a grouped site overview I can limit to a number of rows?
      instructions:
      - text: Get the grouped all-websites dashboard for {period} {date}.
        slots:
          period: query.period
          date: query.date
      - text: Show the grouped website overview limited to {filter_limit} rows.
        slots:
          filter_limit: query.filter_limit
      method: generated
      generated: '2026-10-01'