Skip to main content
Glama

Sextant Web - Website GEO, SEO, and Analytics

Get website revenue by dimension

analytics_getWebsiteRevenueMetrics
Read-onlyIdempotent

Returns revenue grouped by the requested dimension, such as country or referrer, for the selected currency and date range. 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>",
      "type": "<type>",
      "currency": "<currency>"
    },
    "name": "analytics_getWebsiteRevenueMetrics"
  }
}

Input Schema

NameRequiredDescriptionDefault
osNoOperating system used by the visitor.
tagNoTag attached to the tracked activity.
cityNoCity of the visitor.
pathNoFilter by page URL path.
typeYesType of resource or analytics dimension to return.
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.
compareNoComparison period: prev for the previous period or yoy for the same period last year.
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.
utmTermNoUTM campaign search term.
currencyYesCurrency code used for revenue values.
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

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds genuinely useful behavior beyond them: the default Last 7 days window with midnight site-timezone semantics, timezone defaulting, and the fact that it hits one fixed Sextant API endpoint. It still says nothing about result shape or aggregation semantics for the revenue values themselves, so a 4 would overstate it.

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-loaded with purpose, then a compact date-handling block, then endpoint context; every sentence carries information. The mid-sentence 'Dates:' fragment and the trailing endpoint/URL-filter note read slightly as an afterthought, costing a point but not much clarity.

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

Completeness3/5

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

For a 37-parameter tool with no output schema, the definition covers the highest-risk area (date/range/timezone interplay) and the required dimension and currency parameters. It is silent on what the revenue response looks like, whether results are paginated, and how currency conversion is applied, which an agent calling a revenue endpoint would want to know.

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; the description earns an extra point by documenting interaction rules the schema does not state, namely that omitting all date fields yields the app's Last 7 days and that timezone falls back to the site's. It also disambiguates path (page URLs) from query (page query strings), which is otherwise ambiguous in the schema text.

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: 'Returns revenue grouped by the requested dimension, such as country or referrer,' scoped to currency and date range. That distinguishes it in spirit from chart/stats/sessions siblings, but no sibling is named and the reader must infer that 'grouped by dimension' is the differentiating feature versus analytics_getWebsiteRevenueChart or analytics_getWebsiteRevenueStats.

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

Usage Guidelines3/5

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

Gives concrete operational guidance on the date parameters (omit them for the app's Last 7 days, or use range, or startDate/endDate) and notes the timezone default. It does not say when to pick this tool over the revenue siblings (Chart, Sessions, Stats, ExpandedMetrics), so alternative selection is left implicit.

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