Matomo · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/matomo-resolution-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 3

$.info

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

$.paths['/index.php?module=API&method=Resolution.getConfiguration'].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 Resolution API
  version: 1.0.0
extends: openapi/matomo-resolution-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: 2
- target: $.paths['/index.php?module=API&method=Resolution.getResolution'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visitors' screen resolutions
      effect: read
      questions:
      - What screen resolutions do my visitors use?
      - Which display sizes should I design my pages for?
      instructions:
      - text: Show visitor screen resolutions for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List the most common screen sizes on site {idSite} for {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Resolution.getConfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visitors' device configurations
      effect: read
      questions:
      - What combinations of operating system, browser and resolution do visitors have?
      - Which full device configurations are most common on my site?
      instructions:
      - text: Show visitor device configurations for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List the top OS, browser and resolution combinations on site {idSite} for {date} ({period}).
        slots:
          idSite: query.idSite
          date: query.date
          period: query.period
      method: generated
      generated: '2026-10-01'