Matomo · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/matomo-contents-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=Contents.getContentNames'].get

$.paths['/index.php?module=API&method=Contents.getContentPieces'].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 Contents API
  version: 1.0.0
extends: openapi/matomo-contents-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=Contents.getContentNames'].get
  update:
    x-apievangelist-phrasing:
      intent: Report content impressions by name
      effect: read
      questions:
      - How many impressions and interactions did each banner or content block get?
      - Which content names get the most clicks?
      instructions:
      - text: Show content tracking metrics by content name for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List content names with impressions and interactions on site {idSite} in {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=Contents.getContentPieces'].get
  update:
    x-apievangelist-phrasing:
      intent: Report content impressions by piece
      effect: read
      questions:
      - Which content pieces, like a specific image or ad creative, perform best?
      - How do individual content pieces compare on interaction rate?
      instructions:
      - text: Show content tracking metrics by content piece for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: List content pieces and their interactions on site {idSite} in {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'