👋 Welcome

Getting Started

Sign Up & Add Games

SDK Setup & Updates

Sharing & Permissions

Products

Popmall (Catalog)

Music Player

Data Store Editor

Custom Events

Analytics

Product Optimization

Popfeed

Brand Collab

Campaigns

Campaign Control

Support

Questions or Feedback

Metric Definitions

SDK Changelog

Custom Events are an easy way to track metrics that aren’t standard and automatically available. They allow you to:

• Record any event and an associated value
• See metrics for Total Events, Unique Events, Sum, and Average
• See breakdowns of demographics, devices, and more

Example Use Cases

• How many people completed a tutorial and how long did it take them?
• How many players defeat an enemy and how much damage do they take?
• How many crates/eggs are opened?

Setup

Before you start:

1. Create a Super Biz account

2. Set up your BloxbizSDK

1. Call Custom Events

There are two ways to call custom events:

• registerEvent(eventName, playerId) - without a value
• registerEvent(eventName, value, playerId) - with a value (numbers only)

You can call these in a server script like this:

local BloxbizSDK = game.ServerScriptService.BloxbizSDK
local SuperBizAnalytics = require(BloxbizSDK.PublicAPI)

-- register a custom event
SuperBizAnalytics.registerEvent("test_event", player.UserId)

-- register a custom event with a value
SuperBizAnalytics.registerEvent("player_completed_tutorial", 100, player.UserId)

Custom events will print to the console by default in studio. You can turn off these print statements, by setting DebugModeCustomEvents to false.

-- Print to console when a custom event is registered
BloxbizConfig.DebugModeCustomEvents = true

2. See Reports

Custom events automatically record 4 metrics: Total Events, Unique Events, Sum, Average. In addition, you can view custom events for different breakdowns: Day/Week/Month, Country, Language, Device, Membership, Place.

See analytics for your custom events in the Custom Events section in the Reports tab.

Limits

Limits

• Event Calls Per Day: 1,000,000 calls per day per game
• Event Calls Per Minute: 500 calls per minute per game server
• Event Names Per Day: 50 unique names per day per game

Request Higher Limits

We’ll adjust limits over time. Contact us to request higher limits.