# 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 Transitions API
  version: 1.0.0
extends: openapi/matomo-transitions-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: 4
- target: $.paths['/index.php?module=API&method=Transitions.getTransitionsForPageTitle'].get
  update:
    x-apievangelist-phrasing:
      intent: See traffic flow around a page title
      effect: read
      questions:
      - Where do visitors come from and go next around a page with a given title?
      - What pages lead into and out of my pricing page, by title?
      instructions:
      - text: Show transitions for page title {pageTitle} on site {idSite} for {period} {date}.
        slots:
          pageTitle: query.pageTitle
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get previous and following pages for the title {pageTitle} on site {idSite} in {period} {date}.
        slots:
          pageTitle: query.pageTitle
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Transitions.getTransitionsForPageUrl'].get
  update:
    x-apievangelist-phrasing:
      intent: See traffic flow around a page URL
      effect: read
      questions:
      - Which pages do visitors view before and after a specific URL?
      - Where does traffic go after my signup URL?
      instructions:
      - text: Show transitions for page URL {pageUrl} on site {idSite} for {period} {date}.
        slots:
          pageUrl: query.pageUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get the inbound and outbound paths for {pageUrl} on site {idSite} in {period} {date}.
        slots:
          pageUrl: query.pageUrl
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Transitions.getTransitionsForAction'].get
  update:
    x-apievangelist-phrasing:
      intent: See traffic flow around any action
      effect: read
      questions:
      - Can I get transitions for an action by its name and type rather than a URL or title?
      - What came before and after a given tracked action?
      instructions:
      - text: Show transitions for action {actionName} of type {actionType} on site {idSite} for {period} {date}.
        slots:
          actionName: query.actionName
          actionType: query.actionType
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Get the {parts} transition parts for action {actionName} ({actionType}) on site {idSite} in {period} {date}.
        slots:
          parts: query.parts
          actionName: query.actionName
          actionType: query.actionType
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Transitions.isPeriodAllowed'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a period is allowed for transitions
      effect: read
      questions:
      - Is a yearly period allowed for the transitions report?
      - Why can't I run transitions for a long date range?
      instructions:
      - text: Check if period {period} for {date} is allowed for transitions on site {idSite}.
        slots:
          period: query.period
          date: query.date
          idSite: query.idSite
      - text: Tell me whether transitions can run on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'