Skip to main content
Glama
Flowsery

flowsery

Official

Get Traffic Overview

get_overview
Read-only

Get key website metrics for a date range as one row: visitors, sessions, bounce rate, duration, revenue, conversion rate. Use filters like country or device to narrow results in one call.

Instructions

Get headline totals for one website over a date range as a single row: visitors, sessions, bounce rate, average session duration, revenue, revenue per visitor, and conversion rate. Dates default to the last 30 days ending now; timezone defaults to the site setting. Every filter_* argument narrows the whole result, so filter_country plus filter_device answers 'mobile visitors from Germany' in one call. Use get_timeseries for the trend over time and a get_* breakdown tool for the split by page, source, or geography. Requires websiteId or domain with a workspace token.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endAtNoISO 8601 end of the reporting window (e.g. "2026-01-31"). Defaults to now.
limitNoMax rows to return (1-1000, default 100).
domainNoWebsite domain from list_websites (e.g. "example.com"). Alternative to websiteId with a workspace token.
fieldsNoComma-separated metrics to include: visitors, sessions, bounce_rate, avg_session_duration, currency, revenue, revenue_per_visitor, conversion_rate. Omit for all.
offsetNoRows to skip for pagination (default 0). Compare offset + limit against pagination.total in the response.
startAtNoISO 8601 start of the reporting window, date or datetime (e.g. "2026-01-01" or "2026-01-01T00:00:00Z"). Defaults to 30 days ago.
timezoneNoIANA timezone used to bound and bucket the window (e.g. "America/New_York"). Defaults to the website timezone from get_metadata.
filter_osNoFilter by operating system name as returned by get_operating_systems (e.g. "iOS")
websiteIdNoWebsite ID from list_websites. Required with a workspace token unless domain is given; ignored with a website key.
filter_refNoFilter by ref URL parameter
filter_viaNoFilter by via URL parameter
filter_cityNoFilter by city name as returned by get_cities
filter_goalNoFilter to visitors who completed this goal name (as returned by get_goals)
filter_pageNoFilter by page path as returned by get_pages (e.g. "/pricing")
filter_deviceNoFilter by device type: desktop, mobile, tablet
filter_regionNoFilter by region code as returned by get_regions (e.g. US-CA)
filter_sourceNoFilter by source URL parameter
filter_browserNoFilter by browser name as returned by get_browsers (e.g. "Chrome")
filter_channelNoFilter by marketing channel as returned by get_channels (e.g. "Organic Search")
filter_countryNoFilter by country name as returned by get_countries (e.g. "United States"). Every filter_* value accepts the same operators: "v" is, "!v" is not, "~v" contains, "!~v" does not contain, "a|b" any of. Filters combine with AND.
filter_hostnameNoFilter by hostname as returned by get_hostnames (e.g. "app.example.com")
filter_referrerNoFilter by referrer domain as returned by get_referrers (e.g. "google.com")
filter_utm_termNoFilter by UTM term
filter_entry_pageNoFilter by entry/landing page
filter_utm_mediumNoFilter by UTM medium
filter_utm_sourceNoFilter by UTM source
filter_utm_contentNoFilter by UTM content
filter_utm_campaignNoFilter by UTM campaign

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultNoObject with status and data: a single row with visitors, sessions, bounce_rate, avg_session_duration, currency, revenue, revenue_per_visitor, and conversion_rate (a percentage) for the window.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed18 schema fields changedv0.1.1
    • changedInput schema / properties / domain / description
      Previous value: -"Website domain to query. Required when using a workspace token unless websiteId is provided."New value: +"Website domain from list_websites (e.g. \"example.com\"). Alternative to websiteId with a workspace token."
    • changedInput schema / properties / endAt / description
      Previous value: -"ISO 8601 end date (e.g. \"2026-01-31\")"New value: +"ISO 8601 end of the reporting window (e.g. \"2026-01-31\"). Defaults to now."
    • changedInput schema / properties / filter_browser / description
      Previous value: -"Filter by browser name"New value: +"Filter by browser name as returned by get_browsers (e.g. \"Chrome\")"
    • changedInput schema / properties / filter_channel / description
      Previous value: -"Filter by marketing channel"New value: +"Filter by marketing channel as returned by get_channels (e.g. \"Organic Search\")"
    • changedInput schema / properties / filter_city / description
      Previous value: -"Filter by city"New value: +"Filter by city name as returned by get_cities"
    • changedInput schema / properties / filter_country / description
      Previous value: -"Filter by country"New value: +"Filter by country name as returned by get_countries (e.g. \"United States\"). Every filter_* value accepts the same operators: \"v\" is, \"!v\" is not, \"~v\" contains, \"!~v\" does not contain, \"a|b\" any of. Filters combine with AND."
    • changedInput schema / properties / filter_goal / description
      Previous value: -"Filter by goal name"New value: +"Filter to visitors who completed this goal name (as returned by get_goals)"
    • changedInput schema / properties / filter_hostname / description
      Previous value: -"Filter by hostname"New value: +"Filter by hostname as returned by get_hostnames (e.g. \"app.example.com\")"
    • changedInput schema / properties / filter_os / description
      Previous value: -"Filter by operating system"New value: +"Filter by operating system name as returned by get_operating_systems (e.g. \"iOS\")"
    • changedInput schema / properties / filter_page / description
      Previous value: -"Filter by page path"New value: +"Filter by page path as returned by get_pages (e.g. \"/pricing\")"
    • changedInput schema / properties / filter_referrer / description
      Previous value: -"Filter by referrer domain"New value: +"Filter by referrer domain as returned by get_referrers (e.g. \"google.com\")"
    • changedInput schema / properties / filter_region / description
      Previous value: -"Filter by region"New value: +"Filter by region code as returned by get_regions (e.g. US-CA)"
    • changedInput schema / properties / limit / description
      Previous value: -"Max results (1-1000, default: 100)"New value: +"Max rows to return (1-1000, default 100)."
    • changedInput schema / properties / offset / description
      Previous value: -"Pagination offset (default: 0)"New value: +"Rows to skip for pagination (default 0). Compare offset + limit against pagination.total in the response."
    • changedInput schema / properties / startAt / description
      Previous value: -"ISO 8601 start date (e.g. \"2026-01-01\")"New value: +"ISO 8601 start of the reporting window, date or datetime (e.g. \"2026-01-01\" or \"2026-01-01T00:00:00Z\"). Defaults to 30 days ago."
    • changedInput schema / properties / timezone / description
      Previous value: -"IANA timezone (e.g. \"America/New_York\"). Falls back to site default."New value: +"IANA timezone used to bound and bucket the window (e.g. \"America/New_York\"). Defaults to the website timezone from get_metadata."
    • changedInput schema / properties / websiteId / description
      Previous value: -"Website ID to query. Required when using a workspace token unless domain is provided."New value: +"Website ID from list_websites. Required with a workspace token unless domain is given; ignored with a website key."
    • changedOutput schema / properties / result / description
      Previous value: -"Aggregated metrics such as visitors, sessions, bounce rate, average session duration, revenue, revenue per visitor, and conversion rate."New value: +"Object with status and data: a single row with visitors, sessions, bounce_rate, avg_session_duration, currency, revenue, revenue_per_visitor, and conversion_rate (a percentage) for the window."
  2. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds value beyond that by disclosing defaults (date range, timezone), the AND-combination of filters, the 'single row' result shape, and the requirement for websiteId/domain with a workspace token. No contradiction with annotations; a small gap is that pagination behavior is only implied via schema, not described here.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact, front-loaded with purpose, then covers usage alternatives and a key example in two sentences. Every sentence earns its place with no filler.

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 tool with 28 parameters and an output schema, the description covers the core purpose, defaults, filter semantics, alternatives, and auth requirement. It doesn't explicitly discuss pagination or response structure, but those are covered by the output schema and parameter descriptions. Overall, an agent has enough to use it correctly.

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 coverage is 100%, so all 28 parameters have individual descriptions in the schema. The description adds some interpretive value (filters narrow the whole result, default date/timezone) but largely reiterates what the schema already states. Baseline 3 is appropriate because the schema does the heavy lifting.

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 states a specific verb ('Get headline totals') and resource ('one website over a date range'), lists the exact metrics returned, and explicitly names alternatives (get_timeseries, get_* breakdown tools) to distinguish itself. An agent can immediately tell what it does and how it differs from siblings.

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

Usage Guidelines5/5

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

It provides explicit when-to-use guidance: 'Use get_timeseries for the trend over time and a get_* breakdown tool for the split by page, source, or geography.' It also illustrates a filter combination example and notes the auth requirement, leaving no ambiguity about when to pick this tool.

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