Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Image Graph API

2 actions 2 updates phrasing extends openapi/matomo-imagegraph-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=ImageGraph.get'].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 Image Graph API
  version: 1.0.0
extends: openapi/matomo-imagegraph-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=ImageGraph.get'].get
  update:
    x-apievangelist-phrasing:
      intent: Render a report as a static graph image
      effect: read
      questions:
      - Can I get a PNG chart of a report to embed in an email or slide?
      - Which graph types, like pie or evolution, can a report be drawn as?
      - Can I set the width, height and colors of a generated report graph?
      instructions:
      - text: Draw a {graphType} graph of {apiModule}.{apiAction} for site {idSite} for {period} {date}.
        slots:
          graphType: query.graphType
          apiModule: query.apiModule
          apiAction: query.apiAction
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Render the {apiModule} {apiAction} report as a {width} by {height} image.
        slots:
          apiModule: query.apiModule
          apiAction: query.apiAction
          width: query.width
          height: query.height
      method: generated
      generated: '2026-10-01'