Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin User Language API

3 actions 3 updates phrasing extends openapi/matomo-userlanguage-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=UserLanguage.getLanguage'].get

$.paths['/index.php?module=API&method=UserLanguage.getLanguageCode'].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 User Language API
  version: 1.0.0
extends: openapi/matomo-userlanguage-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=UserLanguage.getLanguage'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visitors by browser language
      effect: read
      questions:
      - What languages do my visitors speak, grouped as English, German and so on?
      - Which base language is most common among my site's visitors?
      instructions:
      - text: Get visitor languages for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down visits on site {idSite} by base language for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=UserLanguage.getLanguageCode'].get
  update:
    x-apievangelist-phrasing:
      intent: Report visitors by full locale code
      effect: read
      questions:
      - Can I tell en-US visitors apart from en-GB visitors?
      - Which exact locale codes do my visitors' browsers report?
      instructions:
      - text: Get visitor locale codes for site {idSite}, {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Break down visits on site {idSite} by full language-region code for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'