get_funnel_analysis
Analyze user funnels and conversion paths to understand behavior patterns. Input steps, dates, and filters to track event-based user journeys and improve conversion insights.
Instructions
Analyze user funnels and conversion paths
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endDate | No | End date in ISO format | |
| filters | No | Additional filters | |
| startDate | No | Start date in ISO format | |
| steps | Yes | Funnel steps in order |
Implementation Reference
- src/index.ts:451-461 (handler)The handler function executing the tool logic for 'get_funnel_analysis'. It currently returns a message stating that full implementation requires JWT authentication.private async getFunnelAnalysis(args: any) { // Funnel analysis requires JWT authentication return { content: [ { type: "text", text: "Funnel analysis is not available via API key authentication. JWT authentication is required for this feature.", }, ], }; }
- src/index.ts:203-222 (schema)Input schema (JSON Schema) for the 'get_funnel_analysis' tool, defining parameters like steps, date range, and filters.inputSchema: { type: "object", properties: { steps: { type: "array", description: "Funnel steps in order", items: { type: "object", properties: { name: { type: "string", description: "Step name" }, eventType: { type: "string", description: "Event type (LOCATION, CLICK, CUSTOM)" }, eventValue: { type: "string", description: "Event value to match" } } } }, startDate: { type: "string", description: "Start date in ISO format" }, endDate: { type: "string", description: "End date in ISO format" }, filters: { type: "array", description: "Additional filters" } }, required: ["steps"]
- src/index.ts:200-224 (registration)Registration of the 'get_funnel_analysis' tool in the ListTools response, including name, description, and input schema.{ name: "get_funnel_analysis", description: "Analyze user funnels and conversion paths", inputSchema: { type: "object", properties: { steps: { type: "array", description: "Funnel steps in order", items: { type: "object", properties: { name: { type: "string", description: "Step name" }, eventType: { type: "string", description: "Event type (LOCATION, CLICK, CUSTOM)" }, eventValue: { type: "string", description: "Event value to match" } } } }, startDate: { type: "string", description: "Start date in ISO format" }, endDate: { type: "string", description: "End date in ISO format" }, filters: { type: "array", description: "Additional filters" } }, required: ["steps"] } },
- src/index.ts:290-291 (registration)Dispatch in the CallToolRequest handler that calls the getFunnelAnalysis method for this tool.case "get_funnel_analysis": return await this.getFunnelAnalysis(args);