Skip to main content
Glama
flowsery

flowsery

Official

Get Goal Completions

get_goals
Read-onlyIdempotent

List every configured goal with visitor completion counts for a date range, so you can compare conversions across goals and spot which custom events drive results.

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 for the same list with revenue and percentage, 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.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_goals"
  }
}

Input Schema

NameRequiredDescriptionDefault
endAtNoISO 8601 end of the reporting window (e.g. "2026-01-31"). Defaults to now.
limitNoPage size: how many of the top rows to return in this call. Omit for 100. Raise it for long-tail lists such as cities or pages.
domainNoWebsite domain from list_websites (e.g. "example.com"). Alternative to websiteId with a workspace token.
offsetNoHow many top rows to skip, for reading the next page. Omit to start at the first row. Keep paging while offset + limit is below 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_refNoKeep only visitors whose first visit landed on a URL carrying this ?ref= tag, e.g. "producthunt" for example.com/?ref=producthunt. Values appear in get_breakdown with dimension ref.
filter_viaNoKeep only sessions that landed on a URL carrying this ?via= tag, e.g. "jane" for example.com/?via=jane, the form many affiliate and referral programs use. Matched per session, not per visitor. Values appear in get_breakdown with dimension via.
filter_cityNoFilter by city name as returned by get_cities
filter_goalNoKeep only visitors who completed this goal in the window, e.g. "newsletter_signup". Goal names appear in get_goals.
filter_pageNoKeep only sessions that viewed this page path at least once, e.g. "/pricing". Paths appear in get_pages.
workspaceIdNoWorkspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another
filter_deviceNoFilter by device type as returned by get_devices: "Desktop", "Mobile" or "Tablet". Matching is case-sensitive.
filter_regionNoFilter by region name as returned by get_regions (e.g. "California")
filter_sourceNoKeep only visitors whose first visit landed on a URL carrying this ?source= tag, e.g. "twitter" for example.com/?source=twitter. Values appear in get_breakdown with dimension source.
filter_browserNoFilter by browser name as returned by get_browsers (e.g. "Chrome")
filter_channelNoKeep only visitors whose first visit came from this marketing channel, e.g. "Organic Search" or "Paid Social". Channel names appear in get_channels.
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_hostnameNoKeep only sessions with at least one pageview on this hostname, e.g. "app.example.com" when one website tracks several domains or subdomains. Hostnames appear in get_hostnames.
filter_referrerNoFilter by referrer as returned by get_referrers: a source name such as "Google" for recognized sites, otherwise the domain
filter_utm_termNoKeep only visitors whose first visit was tagged with this utm_term, usually the paid search keyword, e.g. "web analytics". Values appear in get_breakdown with dimension utm_term.
filter_entry_pageNoKeep only visitors whose first visit started on this page path, their landing page, e.g. "/blog/launch". Paths appear in get_breakdown with dimension entry_page.
filter_utm_mediumNoKeep only visitors whose first visit was tagged with this utm_medium, the kind of marketing, e.g. "email", "cpc" or "social". Values appear in get_breakdown with dimension utm_medium.
filter_utm_sourceNoKeep only visitors whose first visit was tagged with this utm_source, the sender of the traffic, e.g. "newsletter" or "google". Values appear in get_breakdown with dimension utm_source.
filter_utm_contentNoKeep only visitors whose first visit was tagged with this utm_content, which tells apart ads or links in one campaign, e.g. "header_cta". Values appear in get_breakdown with dimension utm_content.
filter_utm_campaignNoKeep only visitors whose first visit was tagged with this utm_campaign, the campaign name, e.g. "black_friday". Values appear in get_campaigns.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed32 schema fields changedv1.5.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / filter_channel / description
      Previous value: -"Filter by marketing channel as returned by get_channels (e.g. \"Organic Search\")"New value: +"Keep only visitors whose first visit came from this marketing channel, e.g. \"Organic Search\" or \"Paid Social\". Channel names appear in get_channels."
    • changedInput schema / properties / filter_device / description
      Previous value: -"Filter by device type: desktop, mobile, tablet"New value: +"Filter by device type as returned by get_devices: \"Desktop\", \"Mobile\" or \"Tablet\". Matching is case-sensitive."
    • changedInput schema / properties / filter_entry_page / description
      Previous value: -"Filter by entry/landing page"New value: +"Keep only visitors whose first visit started on this page path, their landing page, e.g. \"/blog/launch\". Paths appear in get_breakdown with dimension entry_page."
    • changedInput schema / properties / filter_goal / description
      Previous value: -"Filter to visitors who completed this goal name (as returned by get_goals)"New value: +"Keep only visitors who completed this goal in the window, e.g. \"newsletter_signup\". Goal names appear in get_goals."
    • changedInput schema / properties / filter_hostname / description
      Previous value: -"Filter by hostname as returned by get_hostnames (e.g. \"app.example.com\")"New value: +"Keep only sessions with at least one pageview on this hostname, e.g. \"app.example.com\" when one website tracks several domains or subdomains. Hostnames appear in get_hostnames."
    • changedInput schema / properties / filter_page / description
      Previous value: -"Filter by page path as returned by get_pages (e.g. \"/pricing\")"New value: +"Keep only sessions that viewed this page path at least once, e.g. \"/pricing\". Paths appear in get_pages."
    • changedInput schema / properties / filter_ref / description
      Previous value: -"Filter by ref URL parameter"New value: +"Keep only visitors whose first visit landed on a URL carrying this ?ref= tag, e.g. \"producthunt\" for example.com/?ref=producthunt. Values appear in get_breakdown with dimension ref."
    • changedInput schema / properties / filter_referrer / description
      Previous value: -"Filter by referrer domain as returned by get_referrers (e.g. \"google.com\")"New value: +"Filter by referrer as returned by get_referrers: a source name such as \"Google\" for recognized sites, otherwise the domain"
    • changedInput schema / properties / filter_region / description
      Previous value: -"Filter by region code as returned by get_regions (e.g. US-CA)"New value: +"Filter by region name as returned by get_regions (e.g. \"California\")"
    • changedInput schema / properties / filter_source / description
      Previous value: -"Filter by source URL parameter"New value: +"Keep only visitors whose first visit landed on a URL carrying this ?source= tag, e.g. \"twitter\" for example.com/?source=twitter. Values appear in get_breakdown with dimension source."
    • changedInput schema / properties / filter_utm_campaign / description
      Previous value: -"Filter by UTM campaign"New value: +"Keep only visitors whose first visit was tagged with this utm_campaign, the campaign name, e.g. \"black_friday\". Values appear in get_campaigns."
    • changedInput schema / properties / filter_utm_content / description
      Previous value: -"Filter by UTM content"New value: +"Keep only visitors whose first visit was tagged with this utm_content, which tells apart ads or links in one campaign, e.g. \"header_cta\". Values appear in get_breakdown with dimension utm_content."
    • changedInput schema / properties / filter_utm_medium / description
      Previous value: -"Filter by UTM medium"New value: +"Keep only visitors whose first visit was tagged with this utm_medium, the kind of marketing, e.g. \"email\", \"cpc\" or \"social\". Values appear in get_breakdown with dimension utm_medium."
    • changedInput schema / properties / filter_utm_source / description
      Previous value: -"Filter by UTM source"New value: +"Keep only visitors whose first visit was tagged with this utm_source, the sender of the traffic, e.g. \"newsletter\" or \"google\". Values appear in get_breakdown with dimension utm_source."
    • changedInput schema / properties / filter_utm_term / description
      Previous value: -"Filter by UTM term"New value: +"Keep only visitors whose first visit was tagged with this utm_term, usually the paid search keyword, e.g. \"web analytics\". Values appear in get_breakdown with dimension utm_term."
    • changedInput schema / properties / filter_via / description
      Previous value: -"Filter by via URL parameter"New value: +"Keep only sessions that landed on a URL carrying this ?via= tag, e.g. \"jane\" for example.com/?via=jane, the form many affiliate and referral programs use. Matched per session, not per visitor. Values appear in get_breakdown with dimension via."
    • changedInput schema / properties / limit / description
      Previous value: -"Max rows to return (1-1000, default 100)."New value: +"Page size: how many of the top rows to return in this call. Omit for 100. Raise it for long-tail lists such as cities or pages."
    • addedInput schema / properties / limit / maximum
      Added value: +1000
    • addedInput schema / properties / limit / minimum
      Added value: +1
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / offset / description
      Previous value: -"Rows to skip for pagination (default 0). Compare offset + limit against pagination.total in the response."New value: +"How many top rows to skip, for reading the next page. Omit to start at the first row. Keep paging while offset + limit is below pagination.total in the response."
    • addedInput schema / properties / offset / minimum
      Added value: +0
    • changedInput schema / properties / offset / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "description": "Workspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another",
      +  "type": "string"
      +}
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / result / additionalProperties
      Added value: +true
    • removedOutput schema / properties / result / description
      Removed value: -"Object with status, data (one entry per configured goal with its name and completion count for the window), and pagination."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "data": {
      +    "items": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "completions": {
      +          "description": "Completions in the window",
      +          "type": [
      +            "number",
      +            "null"
      +          ]
      +        },
      +        "id": {
      +          "type": "string"
      +        },
      +        "name": {
      +          "description": "Goal name; pass as filter_goal or to delete_goals",
      +          "type": "string"
      +        },
      +        "visitors": {
      +          "$ref": "#/properties/result/properties/data/items/properties/completions",
      +          "description": "Same as completions"
      +        }
      +      },
      +      "required": [
      +        "name"
      +      ],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  "pagination": {
      +    "additionalProperties": true,
      +    "properties": {
      +      "limit": {
      +        "type": "number"
      +      },
      +      "offset": {
      +        "type": "number"
      +      },
      +      "total": {
      +        "description": "Rows matching the query before paging",
      +        "type": "number"
      +      }
      +    },
      +    "required": [
      +      "limit",
      +      "offset",
      +      "total"
      +    ],
      +    "type": "object"
      +  },
      +  "status": {
      +    "description": "\"success\" on every successful call",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / result / required
      Added value: +[
      +  "status",
      +  "data",
      +  "pagination"
      +]
    • addedOutput schema / properties / result / type
      Added value: +"object"
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
  2. 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."
  3. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so safety is covered. The description adds value beyond that: the exact composition of the goal list including system-created goals, the 30-day date default, how filter_* restricts the visitor population being counted, how limit/offset page the goal list, and that goals originate from track_goal.

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?

Purpose is front-loaded, then alternatives, then defaults and auth in descending priority, with no filler sentences. It is dense to the point of being a single run-on paragraph, which slightly reduces scannability for a 28-parameter tool, but every clause carries information.

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 28-parameter read tool with an output schema and full annotations, the description covers what is needed to call it correctly: what the list contains, auth requirement, date defaults, filtering scope, paging, and which alternatives answer adjacent questions. Return formatting is rightly left to the output schema.

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 the per-parameter meaning is already carried by the schema, including the operator grammar on filter_* values. The description only adds an aggregate note that filter_* narrows the counted visitors and that limit/offset page the goal list, which is a modest supplement rather than new per-parameter information.

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?

States a specific verb and resource (get every configured goal with completion counts in a date range) and immediately scopes what the list contains: custom events plus the auto-created payment and free_trial goals. It then names three siblings and the distinct question each answers, so the agent can separate this from get_overview, get_breakdown and get_visitor without reading any schema.

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?

Explicit routing: use this to compare conversions across goals, use get_overview for conversion_rate against the KPI goal, get_breakdown with dimension goal for revenue and percentage, get_visitor for one person's completions. It also states prerequisites (websiteId or domain with a workspace token) and the default date window, leaving little to infer.

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