umami-mcp

get_session_stats

Retrieve summarized session statistics for a website, including total sessions and unique visitors, filtered by date range, path, referrer, or custom Umami filters.

Instructions

Get summarized session statistics for a website (total sessions, unique visitors, etc.)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "websiteId": "<websiteId>",
      "startAt": "<startAt>",
      "endAt": "<endAt>"
    },
    "name": "get_session_stats"
  }
}

Input Schema

Name	Required	Description
`path`	No	Filter by URL path
`endAt`	Yes	End timestamp in milliseconds
`filters`	No	Additional Umami v3 filters such as country, device, browser, tag, UTM fields, segment, or cohort
`startAt`	Yes	Start timestamp in milliseconds
`referrer`	No	Filter by referrer
`websiteId`	Yes	Website UUID

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv2.1.1Oct 24, 2026

addedInput schema / properties / filters

Added value: +{
+  "additionalProperties": {
+    "type": [
+      "string",
+      "number",
+      "boolean"
+    ]
+  },
+  "description": "Additional Umami v3 filters such as country, device, browser, tag, UTM fields, segment, or cohort",
+  "type": "object"
+}

addedInput schema / properties / path

Added value: +{
+  "description": "Filter by URL path",
+  "type": "string"
+}

removedInput schema / properties / url

Removed value: -{
-  "description": "Filter by URL path",
-  "type": "string"
-}

First observedv1.2.1Mar 19, 2026

TDQS

B3.3/5.0

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the behavioral burden; it establishes that this is a read-style summary endpoint and gives example return metrics. However, it does not mention permissions, rate limits, date-range behavior, or how filters affect results, leaving meaningful gaps for a stats endpoint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with no wasted text. It efficiently communicates the core purpose and illustrative metrics.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a schema with full parameter coverage and no output schema, the description is adequate on inputs and gives example outputs. It is incomplete for the surrounding toolset because it does not clarify its relationship to get_stats, get_sessions, or other session-related siblings.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all six parameters, including websiteId, startAt, endAt, path, referrer, and filters, are already documented in the schema. The description adds no parameter-level detail beyond the schema, which is acceptable but not additive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific verb and resource: get summarized session statistics for a website, with examples like total sessions and unique visitors. It does not differentiate from closely related siblings such as get_stats, get_sessions, or get_sessions_weekly, leaving ambiguity about which stats tool to choose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit guidance on when to use this tool versus alternatives, despite many sibling tools covering sessions and stats. The word 'summarized' implies a high-level view but does not name alternatives or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server