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.
# 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 Visit Time API
version: 1.0.0
extends: openapi/matomo-visittime-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=VisitTime.getVisitInformationPerLocalTime'].get
update:
x-apievangelist-phrasing:
intent: Show visits by the visitor's local hour
effect: read
questions:
- At what time of day in their own timezone do visitors come to my site?
- Can I see visits grouped by each visitor's local hour?
instructions:
- text: Show visits by visitor local hour for site {idSite}, {period} {date}.
slots:
idSite: query.idSite
period: query.period
date: query.date
- text: Break down visits on site {idSite} by the visitor's own clock time for {date} ({period}).
slots:
idSite: query.idSite
date: query.date
period: query.period
method: generated
generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=VisitTime.getVisitInformationPerServerTime'].get
update:
x-apievangelist-phrasing:
intent: Show visits by the site's hour of day
effect: read
questions:
- Which hours in my site's timezone get the most traffic?
- Can I hide future hours when looking at today's hourly visits?
instructions:
- text: Show visits by hour in the site's timezone for site {idSite}, {period} {date}.
slots:
idSite: query.idSite
period: query.period
date: query.date
- text: 'Give me today''s hourly visits for site {idSite} on {date} ({period}) with future hours hidden: {hideFutureHoursWhenToday}.'
slots:
idSite: query.idSite
date: query.date
period: query.period
hideFutureHoursWhenToday: query.hideFutureHoursWhenToday
method: generated
generated: '2026-10-01'
- target: $.paths['/index.php?module=API&method=VisitTime.getByDayOfWeek'].get
update:
x-apievangelist-phrasing:
intent: Show visits by day of the week
effect: read
questions:
- Which day of the week gets the most visitors?
- Is my weekend traffic lower than weekday traffic?
instructions:
- text: Show visits by day of week for site {idSite}, {period} {date}.
slots:
idSite: query.idSite
period: query.period
date: query.date
- text: Compare Monday through Sunday traffic on site {idSite} for {date} ({period}).
slots:
idSite: query.idSite
date: query.date
period: query.period
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.