n8n-nodes-umami

This is an n8n community node. It lets you read website analytics from
Umami in your n8n workflows.

Umami is an open source, privacy-first web analytics platform — a lightweight
alternative to Google Analytics that collects no cookies and no personal data.

n8n is a fair-code licensed
workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources

Installation

Follow the
installation guide
in the n8n community nodes documentation.

In short: go to Settings → Community Nodes, select Install, and enter
n8n-nodes-umami.

Operations

Website

• Get — retrieve a single tracked website by its ID.
• Get Many — list the websites the account can access, optionally including
  websites shared through a team.

Statistic

• Get Summary — totals for pageviews, visitors, visits, bounces and time on
  site over a date range, with a comparison against the preceding period.
• Get Pageviews — a pageview and session time series, grouped by hour, day,
  month or year.
• Get Metrics — the top values for one dimension: URL path, referrer,
  browser, operating system, device, country, city, event, UTM parameters and
  more.
• Get Active Visitors — how many visitors are on the site right now.

All statistics operations accept optional filters (path, referrer, browser, OS,
device, country, timezone, UTM source and campaign) to narrow the results to a
segment of traffic.

Credentials

This node supports both Umami deployments. Select which one you use in the
credential's Hosting field.

Umami Cloud

API access on Umami Cloud requires a paid plan — it is not part of the free
Hobby tier. Self-hosted Umami has no such restriction.

1. Sign in at cloud.umami.is.
2. Go to Settings → API keys and create a key.
3. In n8n, choose Umami Cloud and paste the key into API Key.

Requests go to https://api.umami.is/v1 with an x-umami-api-key header.

Self-hosted

Self-hosted Umami authenticates with a bearer token rather than an API key.

1. Request a token from your instance:

   curl -X POST https://analytics.example.com/api/auth/login \
     -H "Content-Type: application/json" \
     -d '{"username":"your-username","password":"your-password"}'
   

   Replace analytics.example.com with your own instance — that hostname is a
   documentation placeholder and will not resolve.

2. Copy the token value from the response.

   Copying it by hand is where this usually goes wrong, because a copy out
   of a terminal brings a trailing line break with it and the credential then
   fails (see the troubleshooting note below). These put the token on the
   clipboard on its own, with nothing extra attached:

   Windows (PowerShell):

   (Invoke-RestMethod -Method Post -Uri "https://analytics.example.com/api/auth/login" `
     -ContentType "application/json" `
     -Body '{"username":"your-username","password":"your-password"}').token | Set-Clipboard
   

   macOS / Linux:

   curl -s -X POST https://analytics.example.com/api/auth/login \
     -H "Content-Type: application/json" \
     -d '{"username":"your-username","password":"your-password"}' \
     | python3 -c "import json,sys;print(json.load(sys.stdin)['token'],end='')" \
     | pbcopy   # Linux: xclip -selection clipboard
   

3. In n8n, choose Self-Hosted, enter your Instance URL (for example
   https://analytics.example.com, with no trailing slash and no /api) and
   paste the token into Bearer Token.

Requests go to <instance>/api with an Authorization: Bearer header.

Changing the account's password invalidates its tokens, so if the credential
starts returning 401 after a password change, request a new token and update
the credential.

If the test fails with Invalid character in header content ["Authorization"],
the token field contains a line break. This is the likeliest thing to go wrong
when setting the credential up, because the token is ~380 characters and a
newline is invisible in a masked password field. It usually arrives by copying
the token out of a terminal, which appends one. The fix is to clear the field
completely and paste again without the trailing break — the message means the
header could not be built at all, so nothing was sent and the token itself is
almost certainly fine.

Use the credential's Test button to confirm the connection — it calls /me
and reports whether the credentials are accepted.

Compatibility

Tested against n8n 1.x and the Umami v2 API. The endpoints this node uses
(/websites, /websites/:id/stats, /pageviews, /metrics, /active) are
stable across Umami v2 releases.

Usage

A common pattern is a scheduled traffic report: a Schedule Trigger set to
run every Monday, an Umami node with Get Summary over the previous seven
days, and a Slack or Gmail node that posts the numbers to your team.

For a breakdown rather than a total, use Get Metrics with the Dimension
field — for example Referrer to see where visitors came from, or URL Path
to see the most-read pages.

Get Metrics returns rows of x (the value) and y (a count of unique
visitors, not pageviews). One visitor loading the same page four times counts
once, so these numbers are smaller than the pageview total from Get Summary.
That is Umami's behaviour, not a quirk of this node.

Choosing a period

The dated operations take a Period: Today, Last 24 Hours, Last 7 Days, Last
30 Days, This Month, or Custom Range. Relative periods are resolved when the
workflow runs, and all of them include today's traffic.

Pick Custom Range to set exact Start and End Dates instead. Those are exact
moments, not whole days — a date with no time means midnight, so an end date of
today excludes everything that happened today and returns zero rather than an
error. Set the end to tomorrow, or give an explicit time.

Relative periods exist mainly so the node works as an AI agent tool. An
agent has no clock, so asked for "last week" it cannot fill in two absolute
dates — it stops and asks the user. Given a named period it simply picks one
and calls the tool.

If you are new to n8n, see the
Try it out documentation.

Resources

• n8n community nodes documentation
• Umami documentation
• Umami API reference

License

MIT