get_funnel_analytics
Measure funnel step conversion rates with trace counts and end-to-end metrics. Identify funnels by ID or name to track user progression.
Instructions
Measure a funnel: per-step conversion with trace counts, plus end-to-end metrics.
Identify the funnel by either funnel_id or funnel_name.
Every step row carries an explicit n (number of traces reaching that
step) alongside its conversion percentages, so any chart built from this
can label each bar with its sample size.
Args:
funnel_id: The funnel's UUID.
funnel_name: Its name (resolved to an id for you). Ignored if
funnel_id is given.
time_range: Relative window like "30m", "24h", "7d",
"2w". Converted to the nanosecond bounds the API needs.
Returns:
steps (one row per step: n, errors,
conversion_from_previous_pct, conversion_from_start_pct,
dropped_from_previous), end_to_end metrics, and totals.
Note:
When zero traces complete a step, SigNoz returns HTTP 500
unsupported value: NaN instead of a 0% result (SigNoz issue
#12143). This tool detects that and reports a clean zero, flagged via
end_to_end.zero_trace_fallback.
If a step shows 0 traces, read ``diagnostics``. Besides a wrong span
name, the usual culprit is that SigNoz enforces step ordering
**strictly** (``t_next > t_prev``): spans that complete within the same
clock tick -- instantaneous no-ops -- are not counted as ordered and
will silently under-count even when the sequence is correct.
``end_to_end.errors`` is a MAX across steps, not a sum, and its
``latency`` is hardcoded to p99 by SigNoz -- both are restated in
``end_to_end.caveats``.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| funnel_id | No | ||
| time_range | No | 24h | |
| funnel_name | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||