Skip to main content
Glama
Flowsery

flowsery

Official

Get Traffic by Hostname

get_hostnames
Read-only

Get visitor counts grouped by hostname for a date range, ranked by visitors, to compare traffic across domains and subdomains like www, app, or docs.

Instructions

Get visitors grouped by hostname, ranked by visitors descending, for a date range. Useful when one website tracks several domains or subdomains (www, app, docs); a single-domain site returns one row. Use get_pages for paths within a host, and pass filter_hostname to any other tool to scope it to one host. Rows carry value, visitors, revenue, and percentage with pagination.total; limit defaults to 100 (max 1000). Dates default to the last 30 days; all filter_* arguments apply. 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.
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, data (hostname rows with value, visitors, revenue, percentage, ordered by visitors descending), and pagination {limit, offset, total}.

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: -"Hostnames with visitor counts."New value: +"Object with status, data (hostname rows with value, visitors, revenue, percentage, ordered by visitors descending), and pagination {limit, offset, total}."
  2. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds valuable behavioral details: response rows contain 'value, visitors, revenue, and percentage with pagination.total,' defaults for limit (100, max 1000) and dates (last 30 days), that 'all filter_* arguments apply,' and the authentication requirement (websiteId or domain with workspace token). This goes well beyond the annotations and helps the agent anticipate response structure and prerequisites.

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 a compact paragraph that front-loads the core purpose and ranking, then quickly covers usage differentiation, response contents, defaults, and auth. Every sentence adds information; there is no fluff or repetition. It's appropriately sized for the tool's complexity.

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 tool with 27 parameters, an output schema exists, and annotations are present, the description is remarkably complete. It covers the core function, when to use vs alternatives, response shape, pagination, defaults, filter applicability, and authentication requirements. An agent can confidently invoke this tool correctly based on the description alone, with the schema handling parameter-level details.

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 the baseline is 3. The description adds some value beyond the schema: it clarifies that all filter_* arguments apply (relevant given the large filter set), reiterates the auth context for websiteId/domain, and mentions defaults that are also in the schema. It doesn't introduce new parameter semantics not in the schema, but the 'all filter_* arguments apply' note is a useful consolidation. The extra context about authentication requirements and the response fields elevates it slightly above baseline.

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 clearly states the tool's action: 'Get visitors grouped by hostname, ranked by visitors descending, for a date range.' It names the resource and the ranking, and explicitly contrasts with sibling get_pages ('Use get_pages for paths within a host'), making it easy to distinguish from other get_* tools without inspecting schemas.

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: 'Useful when one website tracks several domains or subdomains; a single-domain site returns one row.' It names the alternative tool (get_pages) and explains how to pass filter_hostname to other tools to scope by hostname, leaving no ambiguity about selection.

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