Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Roll Up Reporting API

4 actions 4 updates phrasing extends openapi/matomo-rollupreporting-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Matomo's API. It is a proposal applied on top of the contract, not a document Matomo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/index.php?module=API&method=RollUpReporting.addRollUp'].get
$.paths['/index.php?module=API&method=RollUpReporting.updateRollUp'].get
$.paths['/index.php?module=API&method=RollUpReporting.getRollUps'].get

OpenAPI Overlay

Raw ↑
# 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 Roll Up Reporting API
  version: 1.0.0
extends: openapi/matomo-rollupreporting-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: 3
- target: $.paths['/index.php?module=API&method=RollUpReporting.addRollUp'].get
  update:
    x-apievangelist-phrasing:
      intent: Create a roll-up website
      effect: write
      questions:
      - How do I combine several websites into one aggregated report?
      - Can I create a roll-up that sums traffic across my sites?
      instructions:
      - text: Create a roll-up named {name} combining sites {sourceIdSites} in timezone {timezone} and currency {currency}.
        slots:
          name: query.name
          sourceIdSites: query.sourceIdSites
          timezone: query.timezone
          currency: query.currency
      - text: Add roll-up site {name} from {sourceIdSites} using {timezone} and {currency}.
        slots:
          name: query.name
          sourceIdSites: query.sourceIdSites
          timezone: query.timezone
          currency: query.currency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=RollUpReporting.updateRollUp'].get
  update:
    x-apievangelist-phrasing:
      intent: Change a roll-up website
      effect: write
      questions:
      - How do I add another site to an existing roll-up?
      - Can I rename a roll-up or change its currency?
      instructions:
      - text: Update roll-up {idSite} to include sites {sourceIdSites}.
        slots:
          idSite: query.idSite
          sourceIdSites: query.sourceIdSites
      - text: Rename roll-up {idSite} to {name}.
        slots:
          idSite: query.idSite
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=RollUpReporting.getRollUps'].get
  update:
    x-apievangelist-phrasing:
      intent: List roll-up websites
      effect: read
      questions:
      - Which roll-up websites have been set up?
      - What aggregated roll-ups exist in my analytics?
      instructions:
      - text: List all roll-up websites.
      - text: Show every configured roll-up and its source sites.
      method: generated
      generated: '2026-10-01'