omnipulse / matomo

1.x-dev 2026-11-10 06:49 UTC

Requires

• php: >=8.2
• omnisense/contracts: ^1.0@dev
• omnisense/omnipulse: ^1.0@dev
• symfony/http-client-contracts: ^3.0

Requires (Dev)

• phpunit/phpunit: ^11.0
• symfony/http-client: ^6.4|^7.0|^8.0

Replaces

• omnireach/matomo: 1.x-dev

MIT

• Marco Meyer

• analytics
• Audience
• framework-agnostic
• matomo
• reporting-api
• entry-pages
• omnipulse

Published on Packagist.org on 2026-11-10 08:18 UTC

README

Formerly omnireach/matomo (renamed on 2026-11-10 with its family: Omnireach\ is now Omnipulse\; this package replaces the former name).

omnisense/omnipulse's Matomo, under any PHP host: visits, visitors, pageviews, bounce rate and visit length of a site, by entry page, page, referrer, country, device or day, through Matomo's Reporting API - a self-hosted Matomo or Matomo Cloud.

use Omnipulse\Matomo\MatomoFactory;
use Omnipulse\Registry;
use Symfony\Component\HttpClient\HttpClient;

$registry = new Registry([new MatomoFactory(HttpClient::create())], [
    'stats' => ['factory' => 'matomo', 'options' => ['url' => 'https://stats.example.org', 'site' => '1', 'token' => '...']],
]);

Options: url, site (idSite), token (a token_auth with view access; anonymous, the default, for reports anyone may view).

The API

The Reporting API (https://developer.matomo.org/api-reference/reporting-api), always by POST with the token in the body (never in a URL, where logs keep it): API.get for the whole site, Actions.getEntryPageUrls, Actions.getPageUrls, Referrers.getAll, UserCountry.getCountry, DevicesDetection.getType for a breakdown (flat=1), period=range over the query's days or period=day for a history. One dimension at a time besides the date (Capabilities::$combined false). Filters on the source, the country and the device become a Matomo segment; a filter on a page or an entry page works in a report broken down by it.

Units: entry-page metrics are those of the visits that started there (entry_nb_visits, entry_nb_actions, entry_bounce_count); a bounce rate is bounces over visits; a visit length is the visit seconds over visits. Distinct visitors over a range are Matomo's own only when the installation processes them, otherwise the sum of each day's (the report's note says so).

Terms: a self-hosted installation's limits are its own (archiving by browser or cron); Matomo Cloud's are its plan's. Reuse: no PHP client of the Reporting API was found to reuse (Matomo's own PHP package, matomo/matomo-php-tracker, sends tracking hits, which is not this).

Usage policy

Matomo's usage policy is declared as data in policy.json (omnisense/contracts' schema, named in composer.json's extra.omnisense.policy), its terms read on 2026-11-10 (https://developer.matomo.org/api-reference/reporting-api): no rate limit declared: an installation's limits are its own (rateLimits: null); rights unknown (the site owner's data); no key required (anonymous). omnipulse's registry enforces it - a call over a limit is never made, a 429 and its Retry-After hold every next call (UsageLimitReachedException) - and a site may tighten it, never loosen it (omnisense/omnipulse's docs/policies.md).

Verified, and not

• Verified (the core's harness, PHP 8.4): the whole site, entry pages, a daily history by country with a device segment, the token by POST, what Matomo cannot answer, a refused token - against answers recorded from Matomo's public demo on 2026-10-24 (trimmed of unread fields); every class loading with the package's requirements alone (BareTest).
• Verified live (docker compose run --rm omnipulse live, 2026-10-24): demo.matomo.cloud, site 1, anonymous - the whole site over the last seven days, then entry pages over two days.
• Not verified: a self-hosted installation with a token.

Licence

MIT. An unofficial client, affiliated with Matomo (InnoCraft) in no way.