# 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 Overlay API
  version: 1.0.0
extends: openapi/matomo-overlay-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: 2
- target: $.paths['/index.php?module=API&method=Overlay.getTranslations'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Overlay UI translations
      effect: read
      questions:
      - What translation strings does the page overlay client use?
      - Can I fetch the localized labels for the Overlay view?
      instructions:
      - text: Get the Overlay translation strings.
      - text: Fetch the labels used by the page overlay client.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Overlay.getFollowingPages'].get
  update:
    x-apievangelist-phrasing:
      intent: List pages reached after a page URL
      effect: read
      questions:
      - Which links on a page do visitors follow to reach other pages?
      - Where do visitors click through to from a given URL in the overlay?
      instructions:
      - text: Show the following pages for {url} on site {idSite} for {period} {date}.
        slots:
          url: query.url
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List pages visitors reached after {url} on site {idSite} in {period} {date}.
        slots:
          url: query.url
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'