# 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 Funnels API
  version: 1.0.0
extends: openapi/matomo-funnels-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: 19
- target: $.paths['/index.php?module=API&method=Funnels.getMetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get summary metrics for a funnel
      effect: read
      questions:
      - What was the overall conversion rate of my checkout funnel last month?
      - How many visits entered and completed a funnel in a given period?
      - Can I get a funnel's headline numbers for just one segment of visitors?
      instructions:
      - text: Get the summary metrics for funnel {idFunnel} on site {idSite} for {period} {date}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show the conversion summary of the funnel for goal {idGoal} on site {idSite}, {period} of {date}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnelsSummary'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare all activated funnels on a site
      effect: read
      questions:
      - Which of my funnels converts best on this site?
      - Can I see one row per active funnel side by side for a date range?
      instructions:
      - text: Show the overview table of all active funnels on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Compare every funnel on site {idSite} row by row for {date} ({period}) within segment {segment}.
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
          segment: query.segment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnelsSummaryTotals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get combined totals across all funnels
      effect: read
      questions:
      - What are the total funnel conversions across all my funnels combined?
      - Can I get aggregate funnel totals for a site rather than per-funnel rows?
      instructions:
      - text: Get the combined totals across all activated funnels on site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Sum up all funnel activity on site {idSite} in {date} by {period}.
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnelFlow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get step-by-step flow metrics for a funnel
      effect: read
      questions:
      - At which step of my signup funnel do most visitors drop off?
      - How many visitors proceed from each funnel step to the next?
      instructions:
      - text: Show per-step flow metrics for funnel {idFunnel} on site {idSite} for {period} {date}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down the step drop-off of the funnel for goal {idGoal} on site {idSite} in {date} ({period}).
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnelFlowTable'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the funnel flow as a data table
      effect: read
      questions:
      - Can I get the funnel flow report in the standard table layout used by other reports?
      - Is there a tabular version of the funnel step flow I can export?
      instructions:
      - text: Export the funnel flow table for funnel {idFunnel} on site {idSite}, {period} {date}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Give me the data-table formatted flow for goal {idGoal}'s funnel on site {idSite} for {date} by {period}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnelStepSubtable'].get
  update:
    x-apievangelist-phrasing:
      intent: Drill into the rows of one funnel step
      effect: read
      questions:
      - What detail rows sit underneath a single step of my funnel?
      - Can I drill into just the third step of a funnel?
      instructions:
      - text: Show the subtable for step {stepPosition} of funnel {idFunnel} on site {idSite}, {period} {date}.
        slots:
          stepPosition: query.stepPosition
          idFunnel: query.idFunnel
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Drill into funnel step {stepPosition} on site {idSite} for {date} ({period}).
        slots:
          stepPosition: query.stepPosition
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnelEntries'].get
  update:
    x-apievangelist-phrasing:
      intent: See where visitors entered a funnel
      effect: read
      questions:
      - Which pages do visitors come from when they enter my funnel?
      - Can I see entry actions for one specific funnel step only?
      instructions:
      - text: List entry actions into funnel {idFunnel} on site {idSite} for {period} {date}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show how visitors entered step {step} of funnel {idFunnel} on site {idSite} in {date} ({period}).
        slots:
          step: query.step
          idFunnel: query.idFunnel
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnelExits'].get
  update:
    x-apievangelist-phrasing:
      intent: See where visitors left a funnel
      effect: read
      questions:
      - Where do people go after abandoning my funnel?
      - What exit actions follow a particular funnel step?
      instructions:
      - text: List exit actions from funnel {idFunnel} on site {idSite} for {period} {date}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show where visitors went after leaving step {step} of funnel {idFunnel} on site {idSite}, {date} ({period}).
        slots:
          step: query.step
          idFunnel: query.idFunnel
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getGoalFunnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the funnel configured for a goal
      effect: read
      questions:
      - What steps are defined in the funnel attached to a goal?
      - Does a particular goal have a funnel configured?
      instructions:
      - text: Show the funnel configured for goal {idGoal} on site {idSite}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
      - text: Get the step definition of goal {idGoal}'s funnel on site {idSite}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getSalesFunnelForSite'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site's ecommerce sales funnel
      effect: read
      questions:
      - What does the sales funnel configured for my shop look like?
      - Is there a configured ecommerce sales funnel on this site?
      instructions:
      - text: Show the configured sales funnel for site {idSite}.
        slots:
          idSite: query.idSite
      - text: Get the ecommerce sales funnel definition of site {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getFunnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a funnel definition by ID
      effect: read
      questions:
      - What steps and patterns make up a funnel I already created?
      - Can I look up a funnel's definition using its funnel ID?
      instructions:
      - text: Get the definition of funnel {idFunnel} on site {idSite}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
      - text: Show the configured steps of funnel ID {idFunnel} for site {idSite}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getAllActivatedFunnelsForSite'].get
  update:
    x-apievangelist-phrasing:
      intent: List all activated funnels on a site
      effect: read
      questions:
      - Which funnels are currently active on my website?
      - What funnel definitions are switched on for a site?
      instructions:
      - text: List all activated funnels on site {idSite}.
        slots:
          idSite: query.idSite
      - text: Show the definitions of every active funnel for site {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.hasAnyActivatedFunnelForSite'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a site has any active funnel
      effect: read
      questions:
      - Does this site have at least one funnel turned on?
      - Is funnel tracking active anywhere on a given website?
      instructions:
      - text: Check whether site {idSite} has any activated funnel.
        slots:
          idSite: query.idSite
      - text: Confirm whether any funnel is switched on for site {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.deleteGoalFunnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete the funnel attached to a goal
      effect: destructive
      questions:
      - How do I remove the funnel from a goal without deleting the goal itself?
      - Can I delete a goal's funnel configuration?
      instructions:
      - text: Delete the funnel configured for goal {idGoal} on site {idSite}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
      - text: Remove goal {idGoal}'s funnel from site {idSite}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.deleteNonGoalFunnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete a standalone funnel
      effect: destructive
      questions:
      - How do I delete a funnel that isn't linked to any goal?
      - Can I remove a standalone funnel by its ID?
      instructions:
      - text: Delete the standalone funnel {idFunnel} on site {idSite}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
      - text: Remove non-goal funnel ID {idFunnel} from site {idSite}.
        slots:
          idFunnel: query.idFunnel
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.setGoalFunnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Create or update a goal's funnel
      effect: write
      questions:
      - How do I add funnel steps to an existing goal?
      - Can I deactivate a goal's funnel without deleting its steps?
      instructions:
      - text: Set the funnel for goal {idGoal} on site {idSite} with steps {steps} and activation {isActivated}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
          steps: query.steps
          isActivated: query.isActivated
      - text: Turn the goal {idGoal} funnel on site {idSite} to activated={isActivated}.
        slots:
          idGoal: query.idGoal
          idSite: query.idSite
          isActivated: query.isActivated
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.saveNonGoalFunnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Create or update a standalone funnel
      effect: write
      questions:
      - Can I build a funnel that isn't tied to a goal?
      - How do I rename or change the steps of a standalone funnel?
      instructions:
      - text: Save standalone funnel {idFunnel} named {funnelName} on site {idSite} with steps {steps}.
        slots:
          idFunnel: query.idFunnel
          funnelName: query.funnelName
          idSite: query.idSite
          steps: query.steps
      - text: Create a non-goal funnel {funnelName} (ID {idFunnel}) on site {idSite} using steps {steps}, described as {description}.
        slots:
          funnelName: query.funnelName
          idFunnel: query.idFunnel
          idSite: query.idSite
          steps: query.steps
          description: query.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.getAvailablePatternMatches'].get
  update:
    x-apievangelist-phrasing:
      intent: List pattern match types for funnel steps
      effect: read
      questions:
      - What kinds of URL matching can a funnel step use, like contains or regex?
      - Which pattern types are available when defining funnel steps?
      instructions:
      - text: List the pattern match types available for funnel steps.
      - text: Show the matching options I can use in a funnel step definition.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Funnels.testUrlMatchesSteps'].get
  update:
    x-apievangelist-phrasing:
      intent: Test a URL against funnel step patterns
      effect: read
      questions:
      - Will a particular page URL match the funnel steps I've defined?
      - Can I check my funnel step patterns before saving the funnel?
      instructions:
      - text: Test whether {url} matches the funnel steps {steps}.
        slots:
          url: query.url
          steps: query.steps
      - text: Check which of the step patterns {steps} the URL {url} satisfies.
        slots:
          steps: query.steps
          url: query.url
      method: generated
      generated: '2026-10-01'