Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Bandwidth API

2 actions 2 updates phrasing extends openapi/matomo-bandwidth-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 2

$.info

$.paths['/index.php?module=API&method=Bandwidth.get'].get

OpenAPI Overlay

# 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 Bandwidth API
  version: 1.0.0
extends: openapi/matomo-bandwidth-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: 1
- target: $.paths['/index.php?module=API&method=Bandwidth.get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get bandwidth metrics for a site and period
      effect: read
      questions:
      - How much bandwidth did my site's pageviews and downloads use last month?
      - Can I get just the total bandwidth column for a date range?
      instructions:
      - text: Get bandwidth metrics for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show only the {columns} bandwidth columns for site {idSite} on {date}.
        slots:
          columns: query.columns
          idSite: query.idSite
          date: query.date
      method: generated
      generated: '2026-10-01'