Event reference
Event names, the stored event shape and field rules.
Event names
Names are snake_case and start with a letter (^[a-z][a-z0-9_]*$, up to 64 characters). These are recognised by the dashboard; any other valid name is stored too.
session_startedsession_endedstage_startedstage_completedplayer_diedplayer_quitcheckpoint_reachedcurrency_earnedcurrency_spentitem_purchaseddeveloper_product_prompteddeveloper_product_purchasedgamepass_promptedgamepass_purchasedcustom_eventfunnel_started
Event shape
{
"eventId": "9db7942ede9a4f4a-2",
"projectId": "my_game",
"universeId": "123", "placeId": "456",
"buildId": "v12",
"serverId": "…", "sessionId": "…",
"playerAnonymousId": "p_784af52e…",
"eventName": "player_died",
"timestamp": "2026-09-28T12:00:00.123Z",
"position": { "x": 3.09, "y": 3.7, "z": 0.85 },
"stageId": "stage_3",
"device": "touch",
"metadata": { "cause": "Lava" }
}Put a cause string in a death's metadata and the dashboard shows it when you select that death.
funnel_started needs { funnel: "tutorial" } in its metadata, the snake_case key of the funnel; the SDK's startFunnel sends it for you.
funnel_step needs { funnel: "tutorial", step: 1 } in its metadata: the funnel key and a whole step number from 1 to 100, plus an optional name of at most 80 characters. The SDK's logFunnelStep sends it for you.
player_progress carries the player's progress values as numbers in its metadata, for example { cash: 1500, rebirths: 2 }. Only each player's latest snapshot in a range counts; non-number values are ignored, and the 12 values the most players send are shown.
The metadata key revenue is reserved for purchase amounts: { robux, kind, productId, productName }. The API removes it unless the project has enabled revenue tracking, and removes it when it is not a valid amount (a finite number from 0 to 1,000,000,000).