Skip to main content
Glama

Get form analytics

formAnalytics_get
Read-only

Get form analytics: views, submissions, completion rate, bounce rate, and device / browser / country / traffic-source breakdowns. Read-only. Use form_list to find formId first. Rate metrics (completionRate, engagementRate, bounceRate) return as numbers (0–100); counts are integers. Each breakdown counts unique visitors per value (a visitor counts once, like uniqueVisitors); for completion on one device, filter by device and read completionRate. Returns { formId, period, metrics, breakdown, totalEvents }. totalEvents is the raw analytics event row count (before deduplication into unique visitors). When from/to both omitted, response returns period: { from: null, to: null } (all time). Constraint: from <= to when both supplied. Analytics are a Pro feature: if the workspace owner is not on Pro, this returns UPGRADE_REQUIRED rather than data, including for history recorded while they were.

Input Schema

NameRequiredDescriptionDefault
toNoEnd of date range as Unix ms timestamp. Must be >= `from` when both set.
fromNoStart of date range as Unix ms timestamp. Must be <= `to` when both set.
deviceNoFilter by device type (default: all)
formIdYesForm ID to get analytics for
countryNoFilter by country code (e.g., "US", "DE", "TR")
includeEventsNoInclude sanitized analytics events for custom analysis (no visitor IDs)
trafficSourceNoFilter by traffic source (e.g., "Direct", "Google", referrer domain)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint/openWorldHint/destructiveHint, yet the description adds substantial behavior beyond them: the Pro-feature gate and its UPGRADE_REQUIRED terminal behavior (including history recorded while Pro), the deduplication semantics that make breakdown counts unique visitors while totalEvents is the raw pre-dedup count, and the specific response shape when from/to are omitted (period: { from: null, to: null }).

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 most important facts are front-loaded: what it returns, then read-only, then prerequisites. It is dense but each sentence carries distinct information (return shape, dedup rule, default period, gating). The only minor waste is 'Read-only', which the readOnlyHint annotation already conveys.

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

Completeness5/5

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

For a 7-parameter read tool with no output schema, the description compensates fully: it documents the return object keys, the meaning of totalEvents vs deduplicated breakdown counts, the all-time default period, and the error path for non-Pro workspaces. An agent has everything needed to call and interpret it.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description goes further by stating that rate metrics are 0–100 numbers vs integer counts, that breakdown counts are per-unique-visitor, that includeEvents returns sanitized events without visitor IDs, and by restating the from<=to constraint. That adds real interpretive value over the property descriptions.

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

Purpose5/5

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

The description opens with a specific verb+resource ('Get form analytics') and enumerates exactly what is returned: views, submissions, completion rate, bounce rate, and device/browser/country/traffic-source breakdowns. This clearly distinguishes it from siblings like form_list, form_get, and formSubmission_list, which serve different purposes.

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

Usage Guidelines4/5

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

It gives an explicit prerequisite ('Use form_list to find formId first') and a concrete usage recipe ('for completion on one device, filter by device and read completionRate'), plus the Pro-plan condition that yields UPGRADE_REQUIRED. It stops short of stating when *not* to use it, but no competing analytics sibling exists, so the routing guidance is largely complete.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.