← All DocsFunnel Tracking

Funnel Tracking

Track onboarding and conversion funnels with drop-off analysis. Link funnels to A/B experiments.

Overview

BaseplateFunnels tracks step-by-step player flows (tutorials, onboarding, purchase flows) and shows where players drop off. The killer feature: link funnel steps to A/B experiments to measure which variant produces better completion rates.

Quick Start

local BaseplateFunnels = require(game.ServerStorage.Baseplate.BaseplateFunnels)

BaseplateFunnels:Init({
    apiKey = "bp_live_your_key",
    apiUrl = "https://baseplate-ab.baseplate-rblx.workers.dev",
})

-- Track onboarding steps
BaseplateFunnels:LogStep(player, "Onboarding", 1, "WelcomeScreen")
BaseplateFunnels:LogStep(player, "Onboarding", 2, "ChooseAvatar")
BaseplateFunnels:LogStep(player, "Onboarding", 3, "FirstQuest")

-- Link to an A/B experiment
BaseplateFunnels:LogStep(player, "Onboarding", 2, "ChooseAvatar", {
    experimentName = "onboarding_flow",
    variantName = "simplified",
})

API Reference

BaseplateFunnels:LogStep(player, funnelName, step, stepName?, options?)

Log a funnel step. Dual-writes to Roblox + Baseplate. Options:

FieldTypeDescription
funnelSessionIdstring?Group steps in a specific session
experimentNamestring?Link to an A/B experiment
variantNamestring?Which variant the player is in

Funnel Analysis API

GET /api/funnels/analysis?funnel=Onboarding&hours=168 returns per-step unique players and drop-off percentages.

GET /api/funnels/analysis?funnel=Onboarding&experiment=onboarding_flow breaks down by A/B variant — see which flow has lower drop-off.