Skip to main content
Glama
Sign In
umami-mcp

umami-mcp

by mikusnuz
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

get_pageviews

Retrieve pageview and session counts over time for a website, with optional filters for path, referrer, timezone, and additional analytics dimensions.

Instructions

Get pageview and session counts over time 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>"
    },
    "name": "get_pageviews"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.1.1
    • 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"
+}
    • 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"
+]
  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?

With no annotations, the description carries the full behavioral burden. It only states that counts are returned over time; it does not disclose read-only/auth expectations, default grouping behavior, supported time-range limits, timezone handling, or the shape of the response.

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?

The definition is a single front-loaded sentence with no wasted words. It is appropriately terse, though it could be slightly more informative without becoming verbose.

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?

For a tool with eight parameters, a nested filters object, an enum unit parameter, and no output schema, this one-sentence description is too thin. It does not explain the returned time-series structure, default time unit, or how the filter and timezone parameters affect results.

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 eight parameters are already documented in the input schema. The description adds only the high-level notion of time-series counts for a website and does not clarify filter semantics, unit behavior, or timezone interaction beyond what the schema already 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?

The description gives a specific verb ('Get') and resources ('pageview and session counts over time') scoped to a website, so an agent can tell it returns a time series rather than an aggregate. However, it does not distinguish itself from close siblings like get_stats, get_metrics, or get_website_charts.

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 overlapping analytics siblings such as get_stats, get_metrics, get_sessions, and get_website_charts. The phrase 'over time' implies time-series usage, but no exclusions or alternatives are named.

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