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. 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

TableJSON 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?

Beyond the readOnlyHint annotation, it discloses the Pro-account prerequisite and failure mode (UPGRADE_REQUIRED, including historical data), the all-time period behavior when dates are omitted, the semantics of totalEvents as pre-deduplication raw counts, and the unit ranges of rate metrics. That is substantial behavioral context the annotations do not carry.

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?

Front-loads the purpose and return summary, then layers constraints and edge cases. Dense but each sentence (units, all-time default, upgrade gating) carries information an agent needs; it is somewhat long but not padded.

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?

Since there is no output schema, the description supplies the response shape ({ formId, period, metrics, breakdown, totalEvents }), the meaning of totalEvents, and the upgrade error path. For a read-only analytics tool with 7 params this is complete enough to invoke correctly.

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 adds meaning beyond the schema: it explains that omitting both from/to yields period { from: null, to: null } (all time), states that rate metrics are 0–100 and counts are integers, and clarifies totalEvents. These are non-obvious semantics not derivable from the schema alone.

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?

Opens with a specific verb+resource ('Get form analytics') and enumerates the exact metrics and breakdown dimensions returned. It names the sibling form_list as the way to obtain formId, so an agent can distinguish it from other form_* tools immediately.

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?

Explicitly routes the agent to form_list to find formId before calling, and flags the Pro-feature gating that returns UPGRADE_REQUIRED. It stops short of naming when-not-to-use alternatives, so it is clear context without full exclusion guidance.

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.