Matomo · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/matomo-tour-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=Tour.getChallenges'].get
$.paths['/index.php?module=API&method=Tour.skipChallenge'].get
$.paths['/index.php?module=API&method=Tour.getLevel'].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 Tour API
  version: 1.0.0
extends: openapi/matomo-tour-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=Tour.getChallenges'].get
  update:
    x-apievangelist-phrasing:
      intent: List onboarding tour challenges
      effect: read
      questions:
      - What onboarding challenges are left for me to complete?
      - Which setup tasks does the product tour suggest?
      instructions:
      - text: List the onboarding tour challenges.
      - text: Show which tour challenges I've done and which remain.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Tour.skipChallenge'].get
  update:
    x-apievangelist-phrasing:
      intent: Skip an onboarding challenge
      effect: write
      questions:
      - Can I skip a tour challenge I don't care about?
      - How do I mark an onboarding task as skipped?
      instructions:
      - text: Skip tour challenge {id}.
        slots:
          id: query.id
      - text: Mark onboarding challenge {id} as skipped.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Tour.getLevel'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my onboarding tour level
      effect: read
      questions:
      - What level have I reached in the onboarding tour?
      - How far am I from the next tour level?
      instructions:
      - text: Get my current tour level.
      - text: Show my onboarding progress level.
      method: generated
      generated: '2026-10-01'