Skip to main content
Glama
Flowsery

flowsery

Official

Get Goal Completions

get_goals
Read-only

Retrieve all configured goals with visitor completion counts in a date range. Compare conversion performance across custom events and auto-created goals.

Instructions

Get every configured goal (custom events plus the auto-created payment and free_trial goals) with how many visitors completed it in the date range. Use this to compare conversions across goals; use get_overview for conversion_rate against the site's KPI goal, get_breakdown with dimension goal when you need filters and pagination on the same list, and get_visitor for one person's completions. Dates default to the last 30 days; filter_* narrows the visitors counted and limit/offset page the goal list. Goals are created by track_goal. 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 (one entry per configured goal with its name and completion count for the window), and pagination.

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: -"Goals with completion stats for the selected date range."New value: +"Object with status, data (one entry per configured goal with its name and completion count for the window), and pagination."
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already indicate readOnlyHint=true and destructiveHint=false. The description reinforces the read-only intent by using 'Get' and 'compare conversions', and also notes that goals are created by track_goal, giving helpful lifecycle context. It does not contradict annotations and adds a small amount of behavioral context beyond the annotations.

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 description is a single paragraph but packs in the core purpose, sibling-tool distinctions, default behavior, filtering semantics, pagination, and authentication requirements. While not broken into sections, it is efficient and every sentence contributes useful context. The length is justified given the tool's complexity and the number of parameters.

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?

The description covers the tool's overall purpose, key usage constraints, and references pagination fields like pagination.total. With the provided schema covering all parameters and context indicating an output schema exists, the description is sufficiently complete. It could explicitly state the output shape (e.g., goal name and visitor count fields), but this is partially covered by the tool name and 'how many visitors completed it' phrasing.

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?

All 27 parameters have descriptions, achieving 100% schema coverage. Many descriptions go beyond the parameter name by providing source endpoints (e.g., 'as returned by get_browsers'), concrete examples (e.g., 'Chrome', 'United States'), and default values. The shared filter-operator explanation is embedded in filter_country, which is slightly awkward but still informative. The descriptions clearly exceed the baseline for covered schemas.

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 'Get every configured goal (custom events plus the auto-created payment and free_trial goals) with how many visitors completed it in the date range', naming the specific resource and action. It also explicitly distinguishes the tool from get_overview, get_breakdown, and get_visitor, giving an agent unambiguous selection guidance.

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?

The description provides strong usage guidance: when to use this tool ('Use this to compare conversions across goals'), when to use alternatives, the default date range, how filter_* parameters work, pagination via limit/offset, and the requirement for websiteId or domain with a workspace token. This leaves little ambiguity for invocation.

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