Umami
Umami is a privacy-friendly, open-source analytics tool. Metribay reads from Umami servers you host yourself.
What you get
Section titled “What you get”| Metric | Meaning | Period value |
|---|---|---|
| Visitors | Unique visitors | Exact unique visitors for the whole period, from Umami |
| Visits | Visits (sessions) | Sum of the days |
| Page views | Page views | Sum of the days |
Days are counted in UTC. Umami’s own dashboard uses your browser’s timezone, so single days can differ slightly. Period totals line up.
Before you start
Section titled “Before you start”Your Umami server must be reachable from the internet:
- over HTTPS on the standard port 443,
- at a public address. Servers on a private network, behind a VPN or only reachable by IP inside your network can’t be reached.
Step 1: Create a user for Metribay
Section titled “Step 1: Create a user for Metribay”You can use your own Umami login, but a separate user is safer: it keeps your admin password out of Metribay, and you can remove it at any time.
-
In Umami, go to Settings → Users and create a user, for example
metribay, with the View only role. -
Give that user access to the websites you want to track. In Umami that usually means adding them to the team that owns the websites.
-
Sign in as the new user once to check it can see the websites.
Step 2: Connect it in Metribay
Section titled “Step 2: Connect it in Metribay”-
Select Add source and choose Umami.
-
Open Use your own credentials and fill in:
- Server URL: the address you open Umami at, like
https://analytics.example.com. Leave off/loginor any other path. - Username and Password of the user from step 1.
- Server URL: the address you open Umami at, like
-
Select Save account and continue. Metribay signs in to check the details.
-
Choose a website from the list. You can search by name or domain.
-
Pick a project and select Connect and start import.
Enter the website by hand
Section titled “Enter the website by hand”Open Enter a resource manually and paste the Website UUID. In Umami, find it under Settings → Websites → Edit as the Website ID, for example 4fb7fa4c-5b46-438d-94b3-3a8fb9bc2e8b.
If collection fails
Section titled “If collection fails”“Use a public HTTPS server URL on port 443.” The address starts with http://, has a port number like :3000, or has extra parts. Use the plain https:// address.
The website isn’t listed. The user can’t see it. Check its access in Umami, then select Refresh resources.
“Needs attention” after it worked. The user’s password may have changed, or the server may be unreachable. Sign in to Umami with the same details to check, then update the saved account.
See also Troubleshooting.