Dashboard

Configuration

Every option accepted by RoStructure.init.

Last updated Oct 9, 2026

Options

OptionRequiredMeaning
projectIdYesYour project ID. Sent as X-Project-Id and in every event.
ingestionKeyYesServer-held key that authenticates your game. Not a dashboard credential.
buildIdYesIdentifies the version of your game. "v" .. game.PlaceVersion is a good default.
endpointYesBase URL, for example https://api.rostructure.com.
pseudonymSaltNoSecret salt for anonymous player IDs. Defaults to the ingestion key. Keep it stable, or IDs change.
enableInStudioNoThe SDK does nothing in Studio unless this is true.
revenueNoOff by default. Set true to let trackPurchase send Robux amounts. It also has to be turned on for the project in Settings; see Revenue is optional and private.
revenueAutoNoDefault true when revenue is on: purchases are recorded from the purchase-finished events at list price. Set false to report exact amounts with trackReceipt. Never changes your receipt handling.
autoTrackNoToggle automatic events: { sessions, deaths, quits }, each on by default.
samplingNoKeep-probability per event name, for example { custom_event = 0.1 }. Use it only for noisy optional events.
flushIntervalNoSeconds a partial batch waits before sending. Default 30 on live servers and 5 in Studio, so test data shows up quickly.
compressNoGzip each request. Default true; makes requests about 10x smaller.
batchSizeNoEvents per request, 1 to 100. Default 100.
maxQueueNoEvents held in memory. Default 5,000. The oldest are dropped when full.
maxRetriesNoRetries per batch before it is dropped. Default 5.
debugNoPrints one line per request.