Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Tracking Matomo.php API

3 actions 3 updates phrasing extends openapi/matomo-matomo-php-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['/matomo.php'].get
$.paths['/matomo.php'].post

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 Tracking Matomo.php API
  version: 1.0.0
extends: openapi/matomo-matomo-php-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['/matomo.php'].get
  update:
    x-apievangelist-phrasing:
      intent: Record one tracking hit via the URL
      effect: write
      questions:
      - How do I record a pageview from my server by calling the tracking URL?
      - Can a single tracking request log an event with category, action and name?
      - Can I attach a user ID or revenue to a tracking hit sent in the querystring?
      instructions:
      - text: Track a pageview titled {action_name} at {url} for site {idsite} with rec {rec}.
        slots:
          action_name: query.action_name
          url: query.url
          idsite: query.idsite
          rec: query.rec
      - text: Record event {e_c} / {e_a} on site {idsite} with rec set to {rec}.
        slots:
          e_c: query.e_c
          e_a: query.e_a
          idsite: query.idsite
          rec: query.rec
      - text: Log a conversion for goal {idgoal} worth {revenue} on site {idsite}, rec {rec}.
        slots:
          idgoal: query.idgoal
          revenue: query.revenue
          idsite: query.idsite
          rec: query.rec
      method: generated
      generated: '2026-10-01'
- target: $.paths['/matomo.php'].post
  update:
    x-apievangelist-phrasing:
      intent: Send tracking hits in bulk via POST
      effect: write
      questions:
      - Can I send hundreds of tracking requests in one HTTP call?
      - Do bulk tracking requests need to be in chronological order?
      instructions:
      - text: 'Bulk-track these requests in one POST: {requests}.'
        slots:
          requests: requestBody.requests
      - text: Replay the queued hits {requests} to the tracker in chronological order as a batch.
        slots:
          requests: requestBody.requests
      method: generated
      generated: '2026-10-01'