# 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 Visits Summary API
  version: 1.0.0
extends: openapi/matomo-visitssummary-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: 10
- target: $.paths['/index.php?module=API&method=VisitsSummary.get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the visits overview report
      effect: read
      questions:
      - What does my site's traffic overview look like for last month?
      - Can I pull visits, bounce rate and time on site in one report?
      instructions:
      - text: Show the visits summary for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get the {columns} columns of the visits overview for site {idSite} in {period} {date}.
        slots:
          columns: query.columns
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=VisitsSummary.getVisits'].get
  update:
    x-apievangelist-phrasing:
      intent: Count visits in a period
      effect: read
      questions:
      - How many visits did my website get yesterday?
      - What was the total number of sessions last week?
      instructions:
      - text: Count visits on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Tell me the number of visits to 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=VisitsSummary.getUniqueVisitors'].get
  update:
    x-apievangelist-phrasing:
      intent: Count unique visitors in a period
      effect: read
      questions:
      - How many unique visitors came to my site this month?
      - How many distinct people visited, not counting repeat visits?
      instructions:
      - text: Count unique visitors on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Report the distinct visitor total for 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=VisitsSummary.getUsers'].get
  update:
    x-apievangelist-phrasing:
      intent: Count logged-in users in a period
      effect: read
      questions:
      - How many users with a User ID visited my site?
      - What is the number of identified users for a date range?
      instructions:
      - text: Count users on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get the number of identified users for 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=VisitsSummary.getActions'].get
  update:
    x-apievangelist-phrasing:
      intent: Count actions in a period
      effect: read
      questions:
      - How many total actions did visitors take on my site?
      - What is the action count across all visits for a day?
      instructions:
      - text: Count actions on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get the total number of actions 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=VisitsSummary.getMaxActions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the most actions in one visit
      effect: read
      questions:
      - What is the highest number of actions anyone took in a single visit?
      - How deep did the most engaged visit go?
      instructions:
      - text: Get the maximum actions in a single visit on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show the most actions recorded in one visit to 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=VisitsSummary.getBounceCount'].get
  update:
    x-apievangelist-phrasing:
      intent: Count bounced visits
      effect: read
      questions:
      - How many visitors left after viewing only one page?
      - What was my bounce count last week?
      instructions:
      - text: Count bounces on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get the number of single-page bounced visits for 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=VisitsSummary.getVisitsConverted'].get
  update:
    x-apievangelist-phrasing:
      intent: Count visits that converted
      effect: read
      questions:
      - How many visits converted a goal this month?
      - What number of sessions resulted in a conversion?
      instructions:
      - text: Count converted visits on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get how many visits converted 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=VisitsSummary.getSumVisitsLength'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total visit time in seconds
      effect: read
      questions:
      - How much total time in seconds did visitors spend on my site?
      - What is the summed visit duration for a period?
      instructions:
      - text: Get the total visit duration in seconds for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Sum time spent on site {idSite} in {period} {date} in seconds.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=VisitsSummary.getSumVisitsLengthPretty'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total visit time as readable text
      effect: read
      questions:
      - Can I get the total time on site as something like '3 days 4 hours'?
      - What is the human-readable total visit duration?
      instructions:
      - text: Get the total visit duration as readable text for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show the formatted total time spent on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'