Skip to main content
Glama

Sextant Web - Website GEO, SEO, and Analytics

Get website heatmaps

analytics_getWebsiteHeatmaps
Read-onlyIdempotent

Heatmaps: without urlPath, the pages that have heatmap data; with urlPath, the click points or scroll depth on that page. Needs heatmaps on in tracking.update. Dates: leave them out for the app's Last 7 days (today and the 6 days before it, from midnight in the site's time zone), or pass range (the app's presets), or startDate and endDate as days (YYYY-MM-DD, both included). timezone defaults to the site's. It calls one fixed endpoint of the Sextant Analytics API (https://sextantweb.com/docs/ai): path filters page URLs, query filters page query strings.

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": {
      "siteId": "<siteId>"
    },
    "name": "analytics_getWebsiteHeatmaps"
  }
}

Input Schema

NameRequiredDescriptionDefault
osNoOperating system used by the visitor.
tagNoTag attached to the tracked activity.
cityNoCity of the visitor.
modeNo
pathNoFilter by page URL path.
unitNoTime interval used to group results: minute, hour, day, month, or year.
endAtNoEnd of the date range as a Unix timestamp in milliseconds.
eventNoFilter by custom event name.
matchNoWhether records must match all filters or any filter.
queryNoFilter by page URL query string.
rangeNoA preset from the app's date picker, in the site's time zone. 7d, 30d, 90d: today and the days before it, from local midnight. 24h: the current hour and the 23 before it. 12m, 24m, 36m: this month and the months before it, from the 1st. month: this month. today: since local midnight. It gives the same numbers as the app. Leave out the other date fields when you use it.
titleNoFilter by page title.
cohortNoID of a saved cohort used to filter visitors.
deviceNoDevice category used by the visitor.
regionNoRegion or subdivision of the visitor.
siteIdYesThe Sextant site ID.
browserNoBrowser used by the visitor.
countryNoCountry code of the visitor.
endDateNoLast day of the range (YYYY-MM-DD), included to its end in the site's time zone. An ISO date-time is used as is.
segmentNoID of a saved segment used to filter results.
startAtNoStart of the date range as a Unix timestamp in milliseconds.
urlPathNoA page path such as /pricing.
utmTermNoUTM campaign search term.
hostnameNoHostname on which the activity occurred.
languageNoPreferred language reported by the visitor browser.
objectIdNoOptional: a short link or tracking pixel of this site, to read its analytics instead of the site's.
referrerNoFilter by referring URL.
timezoneNoIANA time zone used to interpret dates and group results, for example America/New_York.
eventTypeNoEvent type: 1 for a pageview or 2 for a custom event.
startDateNoFirst day of the range (YYYY-MM-DD), from local midnight in the site's time zone. An ISO date-time is used as is.
utmMediumNoUTM campaign medium.
utmSourceNoUTM campaign source.
distinctIdNoCustom identifier assigned to the visitor.
utmContentNoUTM campaign content.
utmCampaignNoUTM campaign name.
excludeBounceNoSet a non-empty value to exclude visits with only one pageview.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare this a safe, idempotent, non-open-world read, so the bar is lower. The description still adds real behavior: the tracking.update prerequisite, the default Last-7-days window with its exact boundaries and site time zone, and the timezone default — none of which annotations or schema convey.

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 mode distinction is front-loaded and the date rules are packed into one dense but scannable sentence. The closing line about the fixed endpoint and the docs URL is mostly overhead, and its tail ('path filters page URLs, query filters page query strings') restates schema descriptions.

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

Completeness4/5

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

For a 36-parameter tool with no output schema, the description covers the decisions that matter — which mode you get, what the default date window is, the time zone, and the enablement prerequisite. It never sketches the response shape (e.g., heatmap point structure, pagination or volume limits), which is the one remaining gap an agent would want filled.

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 97%, so the baseline is 3; the description earns extra credit by explaining urlPath as a mode switch (the schema only calls it 'A page path such as /pricing') and by spelling out the range vs startDate/endDate vs omit-dates precedence. The mode enum (click/scroll) and the many filter params are left to the schema.

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 states exactly what the tool returns and how the answer changes with urlPath: a list of pages with heatmap data when absent, click-point or scroll-depth data for one page when present. The verb is implicit (it returns data rather than acting), and it never names a sibling to contrast with, but the resource and behavior are unmistakable.

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 fork for the primary input (omit urlPath for the page inventory, supply it for per-page detail) plus a hard prerequisite that heatmaps must be enabled in tracking.update. It does not say when to reach for this rather than a breakdown/metrics sibling, so cross-tool routing is left to the name.

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.

Resources