Skip to main content
Glama
Sign In
umami-mcp

umami-mcp

by mikusnuz
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_event_series

Retrieve event metrics over time for a website, grouped by minute, hour, day, month, or year, to track event trends within a date range.

Instructions

Get event metrics over time (event series data) for a website

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>",
      "timezone": "<timezone>"
    },
    "name": "get_event_series"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoFilter by URL path
unitNoTime grouping unit supported by Umami v3
endAtYesEnd timestamp in milliseconds
eventNoFilter by event name
limitNo
filtersNoAdditional Umami v3 filters such as country, device, browser, tag, UTM fields, segment, or cohort
startAtYesStart timestamp in milliseconds
timezoneYesIANA timezone (e.g. 'Asia/Seoul')
websiteIdYesWebsite UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv2.1.1
    • addedInput schema / properties / event
      Added value: +{
+  "description": "Filter by event name",
+  "type": "string"
+}
    • removedInput schema / properties / eventName
      Removed 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 / limit
      Added value: +{
+  "exclusiveMinimum": 0,
+  "type": "integer"
+}
    • addedInput schema / properties / path
      Added value: +{
+  "description": "Filter by URL path",
+  "type": "string"
+}
    • changedInput schema / properties / timezone / description
      Previous value: -"Timezone (e.g. 'Asia/Seoul')"New value: +"IANA timezone (e.g. 'Asia/Seoul')"
    • changedInput schema / properties / unit / description
      Previous value: -"Time grouping unit"New value: +"Time grouping unit supported by Umami v3"
    • changedInput schema / properties / unit / enum
      Previous value: -[
-  "hour",
-  "day",
-  "week",
-  "month",
-  "year"
-]New value: +[
+  "minute",
+  "hour",
+  "day",
+  "month",
+  "year"
+]
    • 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",
+  "timezone"
+]
  2. First observedv1.2.1

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden, yet it discloses nothing about the read-only nature, auth requirements, rate limits, default grouping behavior, or how many series/buckets are returned. Only the bare purpose is conveyed.

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 short sentence with no filler, front-loading the core purpose. It is efficient, though its brevity contributes to the gaps in other dimensions rather than wasting words.

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?

With 9 parameters, a nested free-form filters object, no output schema, and no annotations, the description should explain what the response looks like (series points bucketed by unit) and how filters interact with event/path. None of that is present, leaving the agent guessing about result shape.

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 89%, so nearly every parameter (websiteId, startAt, endAt, timezone, event, path, unit, filters) is already documented in the schema. The description adds no extra meaning such as default unit or filter semantics, so the baseline 3 applies.

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 ('Get event metrics over time (event series data)') scoped to a website, which an agent can distinguish from bulk event listings like get_events. However, it never names or contrasts any sibling such as get_metrics, get_stats, or get_website_charts, leaving the boundary fuzzy.

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?

The description gives no when-to-use guidance, no prerequisites, and no exclusions. An agent cannot tell from the text whether this is the right choice versus get_events, get_event_data_stats, or get_metrics for a time-series request.

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

Deploy Server

Other Tools