Metrics

These tools give an AI assistant read access to funnel performance data. Start with list_available_metrics to discover what can be queried, then call get_kpi_metrics, get_chart_metrics, or get_insight_metrics to retrieve the actual numbers for a specific funnel and date range.

All metric queries require ISO 8601 date strings with timezone offsets (e.g. 2026-01-01T00:00:00.000Z) and a 24-character hex funnel ID. Find funnel IDs with list_workspaces.

Tools

Tool	Purpose	Key inputs	Returns
list_available_metrics	List every available KPI subtype, chart subtype, and insight description	(none)	Catalog of metric types with descriptions
get_kpi_metrics	Get a single numeric KPI for a funnel and date range	funnelId, subtype, from, to	{ value, count? }
get_chart_metrics	Get structured chart/visualization data for a funnel	funnelId, subtype, from, to	Array of { key, value, name?, relativeValue? }
get_insight_metrics	Get survey/question response aggregates for a specific funnel question	funnelId, insightId, from, to	{ title, answers, groupedAnswers? }

get_kpi_metrics

Returns the numeric value of one KPI for the given funnel and date range. Rates (like kpi_completion_rate) also include a count denominator.

Available subtype values (discover descriptions via list_available_metrics): kpi_average_time_on_page, kpi_time_to_completion, kpi_completion_rate, kpi_conversion_rate, kpi_new_contacts, kpi_total_sessions, kpi_messages_sent, kpi_messages_delivery_rate, kpi_messages_open_rate.

Inputs

Name	Type	Required	Description
funnelId	string	Yes	Funnel ID — 24-character hex string
subtype	string (enum)	Yes	KPI type identifier (see list above)
from	string	Yes	Start of the date range — ISO 8601 datetime with timezone (e.g. 2026-01-01T00:00:00.000Z)
to	string	Yes	End of the date range — ISO 8601 datetime with timezone
offset	number	No	Timezone offset in minutes (e.g. -120 for UTC−2)

Returns { data: { type, value, count? } }.

get_chart_metrics

Returns structured data arrays suitable for rendering charts. The shape of data items varies by chart type: some return time-series, others heatmaps or breakdowns. Use list_available_metrics to understand each type.

Available subtype values: chart_page_to_page_conversion_rate, chart_activity_by_daytime, chart_contacts_over_time, chart_visitor_devices, chart_top_utm_sources, chart_time_on_page, chart_button_clicks.

Inputs

Name	Type	Required	Description
funnelId	string	Yes	Funnel ID — 24-character hex string
subtype	string (enum)	Yes	Chart type identifier
from	string	Yes	Start date — ISO 8601 datetime with timezone
to	string	Yes	End date — ISO 8601 datetime with timezone
offset	number	No	Timezone offset in minutes
abTest	"all" | "original" | "variant"	No	A/B test filter; only applies to chart_page_to_page_conversion_rate

Returns { data: Array<{ key, value, name?, relativeValue? }> }.

get_insight_metrics

Returns aggregated response data for a single survey question (insight) inside a funnel. Use list_available_metrics to discover available insightId values for a given funnel.

Inputs

Name	Type	Required	Description
funnelId	string	Yes	Funnel ID — 24-character hex string
insightId	string	Yes	Insight identifier in the format "question_XXXX" — identifies a specific question/survey step in the funnel
from	string	Yes	Start date — ISO 8601 format (e.g. 2026-01-01T00:00:00.000Z)
to	string	Yes	End date — ISO 8601 format
offset	string	No	Timezone offset as a string (e.g. "-120" for UTC−2)

Note: unlike get_kpi_metrics and get_chart_metrics, the offset parameter here is a string, not a number.

Returns { data: { title, answers, groupedAnswers? } } where answers is a map of answer text → response count, and groupedAnswers provides raw/ungrouped aggregates when available.

Related

• Guide: ../../guides/metrics-and-analytics
• REST reference: ../../api-reference/metrics/get-kpi