Download the PHP package adriengras/umami-php without Composer

On this page you can find all versions of the php package adriengras/umami-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of adriengras/umami-php

Informations about the package umami-php

umami-php

CI Latest Version PHP Version

A standalone, framework-free PHP client for the Umami Analytics API (v3.1.0), built on Saloon v4. It covers the full API surface: tracking (/api/send, /api/batch) as well as reporting and admin (auth, stats, websites, users, teams).

The library is transport-only: it knows no business entities, persists nothing and decides nothing. You instantiate the connector explicitly with resolved values — no framework binding, no hidden configuration.

Requirements

Installation

Creating the client

The connector exposes one façade per domain: $umami->tracking, $umami->auth, $umami->stats, $umami->websites, $umami->users, $umami->teams.

Tracking (no authentication)

Tracking endpoints are unauthenticated server-side. Always relay the visitor's userAgent — otherwise Umami's bot filter drops the hit and the library raises a BotFilteredException.

Reporting & admin (authenticate first)

Call login() once: it stores the Bearer token on the connector, so every subsequent reporting/admin call is authenticated automatically.

Stats

Event data

Explore custom-event properties (all windows are epoch-millisecond Periods):

Websites

Users (admin)

Teams

Reports

Saved-report CRUD plus nine on-the-fly generation endpoints. Generation parameters are passed through as-is (the server validates them); the existing Filters value object is reused.

Error handling

Every failed request raises an exception (Saloon's AlwaysThrowOnErrors). All library exceptions extend UmamiApiException.

BotFilteredException is the one case where a 200 response is turned into an error: Umami's bot filter answers /api/send and /api/batch with a 200 body of {"beep":"boop"}, which the library re-qualifies as a failure.

License

MIT © Adrien Gras

All versions of umami-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
saloonphp/saloon Version ^4.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package adriengras/umami-php contains the following files

Loading the files please wait ...