Telemetry SDK

Drop-in Lua module for in-game analytics — sessions, events, heatmaps

Live

May 14, 5:04 PM

No signals yet · data appears after the first monitoring cycle

Download the SDK

Get CarpentersTelemetry.lua and place it in ServerScriptService.

Download .lua

Initialize with API Key

Call .init() with your API key and universe ID. Data flows within 30 seconds.

View Your Data

Sessions, retention, platform breakdown, and custom events appear on your game detail page.

Quick Start

-- CarpentersTelemetry SDK
-- Drop this into ServerScriptService

local CarpentersTelemetry = require(
  game.ServerScriptService.CarpentersTelemetry
)

CarpentersTelemetry.init({
  apiKey = "YOUR_API_KEY_HERE",
  gameId = "YOUR_UNIVERSE_ID",
})

-- That's it! Sessions, heartbeats, and platform
-- data are tracked automatically.

-- Optional: Track custom events
CarpentersTelemetry.trackEvent("boss_defeated", {
  bossName = "Dragon King",
  playerLevel = 45,
  timeTaken = 120,
})

What Gets Tracked Automatically

Heartbeats

Player count + platform breakdown every 60s

Sessions

Start/end times, duration, platform per player

Retention

D1, D7, D30 retention rates computed daily

Custom Events

Track any in-game event with structured data

API Keys

API keys are scoped per game. Create one for each game you want to track.