Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Activity Log API

4 actions 4 updates phrasing extends openapi/matomo-activity-log-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=ActivityLog.getEntries'].get
$.paths['/index.php?module=API&method=ActivityLog.getEntryCount'].get
$.paths['/index.php?module=API&method=ActivityLog.getAllActivityTypes'].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 Activity Log API
  version: 1.0.0
extends: openapi/matomo-activity-log-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=ActivityLog.getEntries'].get
  update:
    x-apievangelist-phrasing:
      intent: List activity log entries
      effect: read
      questions:
      - Who changed settings in our analytics instance recently?
      - Can I see the audit trail of actions taken by one specific user?
      - Is it possible to page through activity log entries for a date range?
      instructions:
      - text: Show the latest activity log entries.
      - text: List activity log entries by user {filterByUserLogin} for {period} {date}.
        slots:
          filterByUserLogin: query.filterByUserLogin
          period: query.period
          date: query.date
      - text: Get {limit} audit entries of type {filterByActivityType} starting at offset {offset}.
        slots:
          limit: query.limit
          filterByActivityType: query.filterByActivityType
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ActivityLog.getEntryCount'].get
  update:
    x-apievangelist-phrasing:
      intent: Count activity log entries
      effect: read
      questions:
      - How many audit log entries were recorded last month?
      - What's the total number of activities a given user has logged?
      instructions:
      - text: Count the activity log entries visible to me.
      - text: Count audit entries for user {filterByUserLogin} of type {filterByActivityType} in {period} {date}.
        slots:
          filterByUserLogin: query.filterByUserLogin
          filterByActivityType: query.filterByActivityType
          period: query.period
          date: query.date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=ActivityLog.getAllActivityTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the available activity types
      effect: read
      questions:
      - What kinds of activities can appear in the audit log?
      - Which activity types does each plugin record?
      instructions:
      - text: List all activity types grouped by plugin.
      - text: Show up to {filterLimit} activity type definitions.
        slots:
          filterLimit: query.filterLimit
      method: generated
      generated: '2026-10-01'