Matomo · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/matomo-api-reference-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=ApiReference.getAllowedPlugins'].get

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

$.paths['/index.php?module=API&method=ApiReference.getOpenApiSpec'].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 API Reference API
  version: 1.0.0
extends: openapi/matomo-api-reference-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=ApiReference.getAllowedPlugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List plugins included in the API reference
      effect: read
      questions:
      - Which plugins have OpenAPI specs generated for the API reference?
      - What plugin names does the API reference cover?
      instructions:
      - text: List the plugins used for API reference spec generation.
      - text: Show which plugins the API reference covers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ApiReference.getAllowedPluginMetadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for API reference plugins
      effect: read
      questions:
      - What details are available about each plugin in the API reference?
      - Can I see descriptions for the plugins covered by the reference?
      instructions:
      - text: Get metadata for the API reference plugins.
      - text: Show descriptive metadata for every plugin in the API reference.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ApiReference.getOpenApiSpec'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a plugin's OpenAPI spec
      effect: read
      questions:
      - How do I get the OpenAPI specification for a specific Matomo plugin?
      - Is there a machine-readable spec for one plugin's API?
      instructions:
      - text: Get the OpenAPI spec for plugin {pluginName}.
        slots:
          pluginName: query.pluginName
      - text: Download the generated OpenAPI document for {pluginName}.
        slots:
          pluginName: query.pluginName
      method: generated
      generated: '2026-10-01'