SDK reference
Every function of the Roblox (Luau) module, the browser and Node clients, and the HTTP endpoints they use.
Setup is covered in Install in Roblox Studio. The Luau module is for your game. The browser and Node clients are for everything around it: your game's website, a Discord bot, a backend.
Luau
The module runs on the server only. Require it from a Script in ServerScriptService and call init once.
init
RoChart.init(config)
Prop
Type
Functions
| Function | What it does |
|---|---|
track(player, event, props?) | Send an event for a player. Attached to their UserId and current session. |
trackServer(event, props?) | Send an event for this server, not a player (distinct id "$server:" .. game.JobId). |
setUserProperties(player, props) | Set properties on the player's profile, such as level or class. |
processReceipt(handler) | Use instead of setting MarketplaceService.ProcessReceipt. Calls your handler with receiptInfo and records a $purchase when it returns PurchaseGranted. |
getFlag(player, key) | A flag's value for the player: true, a variant key such as "test", or nil when the flag is off or unknown. Records an exposure. |
isFeatureEnabled(player, key) | true when the flag is on or returns any variant for the player. Records an exposure. |
getConfig(player, key) | Live config: the payload of the flag's variant for the player (any JSON value), or nil. Records an exposure like getFlag. |
economy(player, { flow, currency, amount, balance?, transactionType?, itemSku? }) | Currency gained (flow = "source") or spent ("sink"), like AnalyticsService:LogEconomyEvent. amount must be above 0. Sends $economy. |
funnelStep(player, funnel, step, stepName?, funnelSessionId?) | A step of a funnel, starting at 1. Pass a funnelSessionId for funnels a player can go through again, such as a shop visit. Sends $funnel_step. |
feedback(player, message, { rating?, category?, board? }?) | Send player feedback to Feedback (board general unless you say otherwise). At most 3 per player per minute. Returns true when it was accepted for sending. |
getFlag, isFeatureEnabled and getConfig yield the first time they're called for a player, then use a 60-second cache. The other functions never yield and never error.
Props are plain tables, sent as JSON. Events are queued and sent in batches. Joins, leaves, server heartbeats with server health, script errors, shutdowns and game pass purchases are sent without any code; see what it sends on its own and the event contract.
Browser
Every browser method is safe to call before init, during server-side rendering, or after opting out: it simply does nothing.
init options
rochart.init(token, options?)
Prop
Type
Methods
| Method | What it does |
|---|---|
capture(event, properties?) | Send an event. |
register(properties) · unregister(key) | Add a property to every later event · remove it. |
identify(id, $set?, $set_once?) | Link the visitor to an id, such as their Roblox UserId. See Players and properties. |
setPersonProperties($set, $set_once?) | Update the current person's properties. |
reset() | Start over as a new anonymous visitor. Call it on logout. |
getDistinctId() · getSessionId() | The current ids. |
group(type, key, properties?) | Attach this user and every later event to a group. |
resetGroups() · getGroups() | Stop attaching groups · the current groups. |
getFeatureFlag(key, { sendEvent? }) | A flag's value. Records an exposure unless sendEvent: false. |
isFeatureEnabled(key, { sendEvent? }) | Whether a flag is on (or any variant). |
getFeatureFlagPayload(key) | The payload for the user's value. |
getAllFlags() | Every flag value. |
onFeatureFlags(callback) | Runs whenever flags load. Returns an unsubscribe function. |
reloadFeatureFlags() | Fetch flags again. |
overrideFeatureFlags(flags | false) | Force values locally for testing. false clears them. |
feedback({ message, board?, rating?, category?, email?, url?, properties?, anonymous? }) | Send feedback. Resolves with its id. See Feedback. |
optOut() · optIn() · hasOptedOut() | Stop or resume capturing for this browser. |
flush() | Send everything queued now. |
shutdown() | Flush and stop this instance (tests, hot reload). |
For a second project on the same page, create another instance: new RoChart().init('rc_other_token', { … }).
Node / Bun
new RoChart({ token, host, … })
Prop
Type
| Method | What it does |
|---|---|
capture({ distinctId, event, properties?, groups?, $set?, $set_once?, timestamp?, uuid? }) | Send an event. timestamp for imports, uuid to make re-sends safe. |
identify({ distinctId, anonDistinctId?, properties?, $set_once? }) | Set person properties, and optionally link a browser's anonymous id. |
setPersonProperties({ distinctId, $set, $set_once? }) | Update person properties. |
groupIdentify({ groupType, groupKey, properties? }) | Create or update a group. |
getFeatureFlag({ distinctId, key, groups?, personProperties?, groupProperties?, sendEvent? }) | A flag's value. Records an exposure unless sendEvent: false. |
isFeatureEnabled(…) · getFeatureFlagPayload(…) | Same inputs as getFeatureFlag. |
getAllFlags({ distinctId, groups?, … }) | Every flag value. |
feedback({ message, board?, distinctId?, rating?, category?, groups?, … }) | Send feedback right away. Resolves with its id. |
flush() · shutdown() | Send what's queued · send and stop. Await one before the process exits. |
pending, sent and dropped count events, which is handy in import scripts.
HTTP endpoints
All three use your public project token. The Luau module uses /i/batch and /i/flags; you can call them from anything that speaks HTTP, including HttpService.
POST /i/batch
Send up to 500 events.
Prop
Type
Each event:
Prop
Type
Returns { "ok": true, "accepted": n }. A 400 means the payload is invalid and the whole batch was rejected. A 401 means the token is wrong. Retry 429, 5xx and network errors. The body can be up to 5 MB.
Special events work as they do in the SDKs:
$identifywithproperties.$anon_distinct_idlinks an anonymous id todistinct_id.$groupidentifywith$group_type,$group_keyand$group_setcreates or updates a group.$feature_flag_calledwith$feature_flagand$feature_flag_responserecords a flag exposure.
POST /i/flags
{ "token": "rc_…", "distinct_id": "123456789", "person_properties": { "platform": "Phone" } }Returns { "flags": { "short-tutorial": "short", "double-xp-weekend": true }, "payloads": {} } with every flag that's on. groups is needed for flags that match by group. person_properties and group_properties add to the stored properties for this check only. This doesn't record exposures.
POST /i/feedback
{ "token": "rc_…", "message": "The boss fight is too hard on mobile", "distinct_id": "123456789", "rating": 5, "category": "difficulty" }Returns { "ok": true, "id": "…", "board": "general" }. All fields are on the Feedback page.