# 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 Ab Testing API
  version: 1.0.0
extends: openapi/matomo-ab-testing-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: 17
- target: $.paths['/index.php?module=API&method=AbTesting.getMetricsOverview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overview metrics per experiment variation
      effect: read
      questions:
      - Which variation is winning my A/B test so far?
      - Can I see summary metrics for every variation in an experiment side by side?
      instructions:
      - text: Show the variation overview for experiment {idExperiment} on site {idSite} for {period} {date}.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Compare all variations of experiment {idExperiment} for {date}.
        slots:
          idExperiment: query.idExperiment
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getMetricDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: Get detailed results for one success metric
      effect: read
      questions:
      - How did each variation do on one specific success metric, like conversions?
      - Can I drill into a single metric's detailed report for an experiment?
      instructions:
      - text: Show detailed {successMetric} results for experiment {idExperiment} on site {idSite} for {period} {date}.
        slots:
          successMetric: query.successMetric
          idExperiment: query.idExperiment
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down the {successMetric} metric of experiment {idExperiment} on {date}.
        slots:
          successMetric: query.successMetric
          idExperiment: query.idExperiment
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.addExperiment'].get
  update:
    x-apievangelist-phrasing:
      intent: Create an A/B test experiment
      effect: write
      questions:
      - How do I set up a new A/B test with variations and success metrics?
      - What do I need to define before creating an experiment, like a hypothesis and targeting?
      instructions:
      - text: Create experiment {name} on site {idSite} with hypothesis {hypothesis}, variations {variations} and success metrics {successMetrics}.
        slots:
          name: query.name
          idSite: query.idSite
          hypothesis: query.hypothesis
          variations: query.variations
          successMetrics: query.successMetrics
      - text: Set up a new A/B test called {name} described as {description} targeting {includedTargets}.
        slots:
          name: query.name
          description: query.description
          includedTargets: query.includedTargets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.updateExperiment'].get
  update:
    x-apievangelist-phrasing:
      intent: Update an experiment's configuration
      effect: write
      questions:
      - Can I change the confidence threshold or traffic share of an existing experiment?
      - What can I edit on an experiment after I've created it?
      instructions:
      - text: Set the confidence threshold of experiment {idExperiment} on site {idSite} to {confidenceThreshold}.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
          confidenceThreshold: query.confidenceThreshold
      - text: Include {percentageParticipants} percent of visitors in existing experiment {idExperiment}.
        slots:
          percentageParticipants: query.percentageParticipants
          idExperiment: query.idExperiment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.startExperiment'].get
  update:
    x-apievangelist-phrasing:
      intent: Start an experiment now
      effect: write
      questions:
      - Can I launch an A/B test immediately instead of waiting for its start date?
      - What starts an experiment running right away?
      instructions:
      - text: Start experiment {idExperiment} on site {idSite} now.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
      - text: Launch A/B test {idExperiment} immediately.
        slots:
          idExperiment: query.idExperiment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.finishExperiment'].get
  update:
    x-apievangelist-phrasing:
      intent: Finish an experiment
      effect: destructive
      questions:
      - How do I end an A/B test so it stops collecting new data?
      - Does finishing an experiment stop new tracking requests from counting?
      instructions:
      - text: Finish experiment {idExperiment} on site {idSite}.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
      - text: Stop A/B test {idExperiment} from accepting new tracking requests.
        slots:
          idExperiment: query.idExperiment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.archiveExperiment'].get
  update:
    x-apievangelist-phrasing:
      intent: Archive an experiment
      effect: destructive
      questions:
      - Can I hide an old experiment from reports and segments without deleting it?
      - What happens to an experiment once it's archived?
      instructions:
      - text: Archive experiment {idExperiment} on site {idSite}.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
      - text: Move A/B test {idExperiment} to the archive so it leaves reports.
        slots:
          idExperiment: query.idExperiment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getJsIncludeTemplate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the A/B testing tracker script tag
      effect: read
      questions:
      - What script tag do I add to my pages to load the A/B testing JavaScript?
      - Is there a ready include snippet for the experiments tracker?
      instructions:
      - text: Give me the script tag that includes the A/B testing tracker.
      - text: Get the JavaScript include template for experiments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getJsExperimentTemplate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the JavaScript snippet for one experiment
      effect: read
      questions:
      - What code do I embed on a page to run a specific experiment?
      - Can I get the per-experiment JavaScript snippet to paste into my site?
      instructions:
      - text: Get the JavaScript snippet that runs experiment {idExperiment} on site {idSite}.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
      - text: Show the embed code for A/B test {idExperiment}.
        slots:
          idExperiment: query.idExperiment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getAllExperiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List all experiments for a site
      effect: read
      questions:
      - Which A/B tests have ever been set up on my website?
      - Can I list every experiment for a site regardless of status?
      instructions:
      - text: List all experiments on site {idSite}.
        slots:
          idSite: query.idSite
      - text: Show every A/B test ever configured for website {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getActiveExperiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List currently active experiments
      effect: read
      questions:
      - Which A/B tests are running on my site right now?
      - Can I see only the experiments that are currently active?
      instructions:
      - text: List the active experiments on site {idSite}.
        slots:
          idSite: query.idSite
      - text: Show the A/B tests running right now on website {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getExperimentsByStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List experiments filtered by status
      effect: read
      questions:
      - Can I list only finished or archived experiments?
      - How can I filter my experiments by one or more statuses?
      instructions:
      - text: List experiments on site {idSite} with status {statuses}.
        slots:
          idSite: query.idSite
          statuses: query.statuses
      - text: Filter A/B tests on website {idSite} to statuses {statuses}.
        slots:
          idSite: query.idSite
          statuses: query.statuses
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getExperiment'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one experiment's definition
      effect: read
      questions:
      - What variations, targets and metrics does a particular experiment use?
      - Can I fetch a single experiment's full setup by ID?
      instructions:
      - text: Get the definition of experiment {idExperiment} on site {idSite}.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
      - text: Show me how A/B test {idExperiment} is configured.
        slots:
          idExperiment: query.idExperiment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.deleteExperiment'].get
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete an experiment
      effect: destructive
      questions:
      - How do I permanently delete an A/B test?
      - Is deleting an experiment reversible, unlike archiving it?
      instructions:
      - text: Permanently delete experiment {idExperiment} on site {idSite}.
        slots:
          idExperiment: query.idExperiment
          idSite: query.idSite
      - text: Remove A/B test {idExperiment} for good.
        slots:
          idExperiment: query.idExperiment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getAvailableStatuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List valid experiment statuses
      effect: read
      questions:
      - What status values can an experiment have?
      - Which statuses can I use when filtering experiments?
      instructions:
      - text: List the valid experiment statuses for site {idSite}.
        slots:
          idSite: query.idSite
      - text: Show the possible A/B test status values on website {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getAvailableSuccessMetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List success metrics available to experiments
      effect: read
      questions:
      - Which success metrics, like goals or revenue, can I measure an experiment by?
      - What metrics can be assigned to an A/B test on my site?
      instructions:
      - text: List the success metrics I can assign to experiments on site {idSite}.
        slots:
          idSite: query.idSite
      - text: Show the measurable outcomes available for A/B tests on website {idSite}.
        slots:
          idSite: query.idSite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=AbTesting.getAvailableTargetAttributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List targeting attributes and rule types
      effect: read
      questions:
      - Which page attributes can I target an experiment on, like URL or path?
      - What targeting rule types are supported for experiments?
      instructions:
      - text: List the target attributes and rule types for experiment targeting.
      - text: Show the options for deciding which pages an experiment runs on.
      method: generated
      generated: '2026-10-01'