rybbit-mcp

Goal Sessions

rybbit_get_goal_sessions

Read-onlyIdempotent

Retrieve sessions that completed a specific goal to analyze goal conversions and identify which users triggered them.

Instructions

Get sessions that completed a specific goal. Useful for analyzing which users and sessions triggered goal conversions.

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No	Page number, 1-indexed (default: 1)
`limit`	No	Results per page (default: 20-50 depending on endpoint, max 200)
`goalId`	Yes	Goal ID to get sessions for. Use rybbit_list_goals to find goal IDs.
`siteId`	Yes	Site ID (numeric ID or domain identifier)
`endDate`	No	End date (YYYY-MM-DD)
`filters`	No	Filters to apply
`timeZone`	No	IANA timezone (default UTC)
`startDate`	No	Start date (YYYY-MM-DD)
`pastMinutesEnd`	No	Minutes ago end
`pastMinutesStart`	No	Minutes ago start

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	No	Sessions that hit the goal

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.8.1Sep 28, 2026

changedInput schema / properties / filters / items / properties / parameter / description

Previous value: -"Filter dimension. One of: browser, browser_version, operating_system, operating_system_version, language, country, region, city, device_type, device_model, app_version, dimensions, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id, lat, lon, timezone, vpn, crawler, datacenter, company, company_type, company_domain, asn_org, asn_type, asn_domain, tag. Custom URL parameters use the prefix 'url_param:NAME' (e.g., 'url_param:campaign_id'). Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id). device_model and app_version are populated only for app-type sites tracked via SDK."New value: +"Filter dimension. One of: browser, browser_version, operating_system, operating_system_version, language, country, region, city, device_type, device_model, app_version, dimensions, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id, lat, lon, timezone, tag. Custom URL parameters use the prefix 'url_param:NAME' (e.g., 'url_param:campaign_id'). Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id). device_model and app_version are populated only for mobile-type sites (legacy: app) tracked via SDK."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
+  "properties": {
+    "data": {
+      "description": "Sessions that hit the goal",
+      "items": {
+        "additionalProperties": {},
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}

Addedv0.5.1Apr 30, 2026
RemovedApr 30, 2026

Changed1 schema field changedv0.4.3Apr 30, 2026

changedInput schema / properties / filters / items / properties / parameter / description

Previous value: -"Filter dimension: browser, operating_system, language, country, region, city, device_type, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id. Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id)."New value: +"Filter dimension. One of: browser, browser_version, operating_system, operating_system_version, language, country, region, city, device_type, device_model, app_version, dimensions, referrer, hostname, pathname, page_title, querystring, event_name, channel, utm_source, utm_medium, utm_campaign, utm_term, utm_content, entry_page, exit_page, user_id, lat, lon, timezone, vpn, crawler, datacenter, company, company_type, company_domain, asn_org, asn_type, asn_domain, tag. Custom URL parameters use the prefix 'url_param:NAME' (e.g., 'url_param:campaign_id'). Note: user_id filter checks BOTH the device hash (user_id) and app-provided ID (identified_user_id). device_model and app_version are populated only for app-type sites tracked via SDK."

First observedv0.5.2Apr 2, 2026

TDQS

A3.5/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds no behavioral context beyond annotations, such as pagination behavior, default ordering, or whether the goal must exist, leaving it at the minimum-viable level.

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?

Two short sentences, purpose front-loaded, no wasted words. It is efficient but very sparse given the tool's parameter richness.

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?

An output schema exists, so return-value explanation is unnecessary, and the schema fully covers parameters. For a straightforward read-only analytics query, the description plus structured fields is sufficient, though it could say more about when this beats sibling session tools.

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 description coverage is 100%, so the schema fully documents all 10 parameters, including goalId's pointer to rybbit_list_goals and the filter dimension list. The description adds no parameter meaning beyond this, so the baseline 3 applies.

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 ('Get sessions') plus a scope qualifier ('that completed a specific goal'), which distinguishes it from rybbit_list_sessions. It does not explicitly name siblings, but the goal-scoping makes the purpose unambiguous.

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?

'Useful for analyzing which users and sessions triggered goal conversions' implies a use case but gives no when/when-not guidance or alternative routing (e.g., use rybbit_list_goals first, or use list_sessions for unfiltered data). Usage is only implied.

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

Deploy Server