Matomo · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/matomo-cohorts-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=Cohorts.getCohortsOverTime'].get

$.paths['/index.php?module=API&method=Cohorts.getCohorts'].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 Cohorts API
  version: 1.0.0
extends: openapi/matomo-cohorts-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=Cohorts.getCohortsOverTime'].get
  update:
    x-apievangelist-phrasing:
      intent: Track chosen cohorts over a date range
      effect: read
      questions:
      - How did visitors who first arrived in January keep returning over the following months?
      - Can I follow specific cohort start dates across a display range?
      instructions:
      - text: Show cohorts {cohorts} on site {idSite} by {period} over {displayDateRange}.
        slots:
          cohorts: query.cohorts
          idSite: query.idSite
          period: query.period
          displayDateRange: query.displayDateRange
      - text: Track retention of the {cohorts} cohorts across {displayDateRange}.
        slots:
          cohorts: query.cohorts
          displayDateRange: query.displayDateRange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=Cohorts.getCohorts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the cohort retention table for a period
      effect: read
      questions:
      - What does my visitor retention cohort table look like this month?
      - Can I build cohorts on a metric other than returning visitors?
      instructions:
      - text: Get the cohort table for site {idSite} for {period} {date}.
        slots:
          idSite: query.idSite
          period: query.period
          date: query.date
      - text: Show cohorts measured by {metric} for site {idSite} on {date}.
        slots:
          metric: query.metric
          idSite: query.idSite
          date: query.date
      method: generated
      generated: '2026-10-01'