# 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 Live API
  version: 1.0.0
extends: openapi/matomo-live-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=Live.getCounters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get live visitor counters
      effect: read
      questions:
      - How many people are on my website right now in Matomo?
      - Can I count visits and actions from the last 30 minutes?
      instructions:
      - text: Get live visit counters for site {idSite} over the last {lastMinutes} minutes.
        slots:
          idSite: query.idSite
          lastMinutes: query.lastMinutes
      - text: Count visitors on site {idSite} in the past {lastMinutes} minutes matching segment {segment}.
        slots:
          idSite: query.idSite
          lastMinutes: query.lastMinutes
          segment: query.segment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Live.isVisitorProfileEnabled'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if visitor profiles are enabled
      effect: read
      questions:
      - Are individual visitor profiles turned on for my site?
      - Can I view a visitor's profile on this site, or is the feature disabled?
      instructions:
      - text: Check whether visitor profiles are enabled for site {idSite}.
        slots:
          idSite: query.idSite
      - text: Tell me if site {idSite} allows visitor profiles.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Live.getLastVisitsDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest visits in detail
      effect: read
      questions:
      - Who visited my site most recently, and what did they do?
      - Can I fetch the last 20 visits with their actions for a given period?
      - What visits happened since a particular timestamp?
      instructions:
      - text: Show the most recent visits for site {idSite}.
        slots:
          idSite: query.idSite
      - text: Fetch the last {countVisitorsToFetch} visits on site {idSite} with their action details.
        slots:
          countVisitorsToFetch: query.countVisitorsToFetch
          idSite: query.idSite
      - text: List visits on site {idSite} since timestamp {minTimestamp}, segment {segment}.
        slots:
          idSite: query.idSite
          minTimestamp: query.minTimestamp
          segment: query.segment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Live.getVisitorProfile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a visitor's profile
      effect: read
      questions:
      - What has one returning visitor done across all their visits?
      - Can I see a summary profile for a specific visitor ID?
      instructions:
      - text: Get the visitor profile for visitor {visitorId} on site {idSite}.
        slots:
          visitorId: query.visitorId
          idSite: query.idSite
      - text: Build a profile of visitor {visitorId} on site {idSite} from their last {limitVisits} visits.
        slots:
          visitorId: query.visitorId
          idSite: query.idSite
          limitVisits: query.limitVisits
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Live.getMostRecentVisitorId'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the ID of the latest visitor
      effect: read
      questions:
      - What's the visitor ID of whoever visited last?
      - Can I get the most recent visitor ID within a segment?
      instructions:
      - text: Get the visitor ID of the most recent visit on site {idSite}.
        slots:
          idSite: query.idSite
      - text: Return the latest visitor ID on site {idSite} matching segment {segment}.
        slots:
          idSite: query.idSite
          segment: query.segment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Live.getMostRecentVisitsDateTime'].get
  update:
    x-apievangelist-phrasing:
      intent: Get when the site was last visited
      effect: read
      questions:
      - When was the last time anyone did something on my site?
      - Is tracking still working — what's the timestamp of the latest action?
      instructions:
      - text: Get the UTC time of the most recent action on site {idSite}.
        slots:
          idSite: query.idSite
      - text: Tell me when site {idSite} last recorded activity.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'