Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Umami (BYOK) — connector documentation

  • MCP endpoint: https://byok-umami.connectorbay.com/mcp
  • REST API: POST https://byok-umami.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-umami.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Umami Umami Cloud API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-umami.connectorbay.com/health · Tool schemas: https://byok-umami.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-umami · agent@connectorbay.com

What Umami (BYOK) is for

Umami (BYOK) lets an AI assistant read your own Umami data through the Umami API with a key you supply (Umami Cloud API key). Read-only: 6 tools (get_me, list_websites, get_website_stats, get_website_pageviews, get_website_metrics, get_active_visitors). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.umami.is. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Umami. Umami and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Umami account is my API key connected to?"
  • "Which websites do I track in Umami?"
  • "How many visitors did my Umami website get last month?"
  • "Show my Umami pageviews per day last week"
  • "What are my top Umami pages this month?"
  • "How many people are on my Umami website right now?"

What it does

  • get_me: Show who the key belongs to: Umami username, role and the name of the API key.
  • list_websites: List the tracked websites with ID, name, domain and creation date. Filter by search text; page with page and page_size.
  • get_website_stats: Get a website's totals for a period: pageviews, unique visitors, visits, bounces and total time, optionally compared with the previous period or year, and filtered by page, referrer, country, device or UTM.
  • get_website_pageviews: Get a website's pageviews and sessions as a time series (points with x time and y count) for a period, grouped by minute, hour, day, month or year, optionally with a comparison period.
  • get_website_metrics: Get the most frequent values of one dimension for a period, such as top pages (path), referrers, countries, browsers, devices or events, each with a count (y) of views or unique visitors.
  • get_active_visitors: Get how many unique visitors a website has right now.

BYOK key

You bring your own Umami Umami Cloud API key (https://docs.umami.is/docs/cloud/api-key). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.umami.is over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Umami API (api.umami.is) with a BYOK key; documentation: https://docs.umami.is/docs/api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Umami. Umami and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Umami account.

Built for: Worldwide. Languages: English.