umami-mcp

get_events

Retrieve and filter event rows for a website using Umami v3 filters, search, and pagination. Use it to list events within a timestamp range by path, event name, or custom criteria.

Instructions

List event rows for a website with current Umami v3 filters and pagination

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_events"
  }
}

Input Schema

Name	Required	Description
`page`	No
`path`	No	Filter by URL path
`endAt`	Yes	End timestamp in milliseconds
`event`	No	Filter by event name
`search`	No	Free-text search
`filters`	No	Additional Umami v3 filters such as country, device, browser, tag, UTM fields, segment, or cohort
`startAt`	Yes	Start timestamp in milliseconds
`pageSize`	No
`websiteId`	Yes	Website UUID
`maxResults`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed11 schema fields changedv2.1.1Oct 24, 2026

addedInput schema / properties / event

Added value: +{
+  "description": "Filter by event name",
+  "type": "string"
+}

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 / maxResults

Added value: +{
+  "exclusiveMinimum": 0,
+  "type": "integer"
+}

addedInput schema / properties / page

Added value: +{
+  "exclusiveMinimum": 0,
+  "type": "integer"
+}

addedInput schema / properties / pageSize

Added value: +{
+  "exclusiveMinimum": 0,
+  "type": "integer"
+}

addedInput schema / properties / path

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

addedInput schema / properties / search

Added value: +{
+  "description": "Free-text search",
+  "type": "string"
+}

removedInput schema / properties / timezone

Removed value: -{
-  "description": "Timezone (e.g. 'Asia/Seoul')",
-  "type": "string"
-}

removedInput schema / properties / unit

Removed value: -{
-  "description": "Time grouping unit",
-  "enum": [
-    "hour",
-    "day",
-    "week",
-    "month",
-    "year"
-  ],
-  "type": "string"
-}

removedInput schema / properties / url

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

changedInput schema / required

Previous value: -[
-  "websiteId",
-  "startAt",
-  "endAt",
-  "unit"
-]New value: +[
+  "websiteId",
+  "startAt",
+  "endAt"
+]

First observedv1.2.1Mar 19, 2026

TDQS

C2.9/5.0

Behavior2/5

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

With no annotations, the description carries the full behavioral burden. 'List' implies a read, but the description does not state whether this is read-only, how pagination parameters interact (page, pageSize, maxResults), what the return shape is, or any rate/permission constraints.

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

Conciseness4/5

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

A single well-formed sentence that is front-loaded and free of padding. It is appropriately sized, though 'current Umami v3 filters' is slightly jargon-heavy.

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

Completeness2/5

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

This is a complex 10-parameter query tool with a nested filters object, no annotations, and no output schema. The description does not explain return fields, pagination limits, how maxResults and pageSize interact, or what happens when filters conflict with top-level path/event/search parameters.

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 70%, so the schema already documents most parameters including the nested 'filters' object. The description only repeats that filters and pagination exist without adding format, examples, or meaning beyond what the schema provides.

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?

States a specific verb and resource: 'List event rows for a website.' The mention of Umami v3 filters and pagination clarifies the scope, but it does not distinguish this from closely named siblings such as get_event_data_events, get_event_series, or get_event_values.

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 like get_event_data_events, get_event_series, get_event_data_values, or get_stats. The phrase 'current Umami v3 filters' is vague and does not help an agent choose between event-related siblings.

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

Deploy Server