# 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 Devices Detection API
  version: 1.0.0
extends: openapi/matomo-devicesdetection-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: 8
- target: $.paths['/index.php?module=API&method=DevicesDetection.getType'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by device type
      effect: read
      questions:
      - How much of my traffic comes from phones versus desktops?
      - What share of visits are from tablets?
      instructions:
      - text: Show visits by device type for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down site {idSite} traffic into desktop, smartphone and tablet for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=DevicesDetection.getBrand'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by device brand
      effect: read
      questions:
      - Which device manufacturers do my visitors use most?
      - How many visits came from Apple versus Samsung devices?
      instructions:
      - text: Show visits by device brand for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List device brands visiting site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=DevicesDetection.getModel'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by device model
      effect: read
      questions:
      - Which specific phone models are visiting my site?
      - What are the most common device models among my visitors?
      instructions:
      - text: Show visits by device model for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List device models seen on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=DevicesDetection.getOsFamilies'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by operating system
      effect: read
      questions:
      - What operating systems do my visitors use?
      - How many visits came from Android compared with iOS?
      instructions:
      - text: Show visits by operating system family for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down site {idSite} visits by OS for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=DevicesDetection.getOsVersions'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by OS version
      effect: read
      questions:
      - Which operating system versions are my visitors running?
      - Are many visitors still on an old OS version?
      instructions:
      - text: Show visits by operating system version for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List OS versions visiting site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=DevicesDetection.getBrowsers'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by browser
      effect: read
      questions:
      - Which browsers do my visitors use, ignoring version numbers?
      - What share of traffic is Chrome versus Firefox versus Safari?
      instructions:
      - text: Show visits by browser family for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down site {idSite} traffic by browser for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=DevicesDetection.getBrowserVersions'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by browser version
      effect: read
      questions:
      - Which specific browser versions visit my site?
      - Do I still get visits from outdated browser versions?
      instructions:
      - text: Show visits by browser version for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List browser versions seen on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=DevicesDetection.getBrowserEngines'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visits by browser engine
      effect: read
      questions:
      - Which rendering engines like Blink, Gecko or WebKit do my visitors use?
      - How is traffic split across browser engines?
      instructions:
      - text: Show visits by browser engine for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down site {idSite} visits by rendering engine for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'