Send user events
With the justtrack SDK, you can monitor and record user behaviors as events. These allow you to track how your users are using your app. For each event, you can also specify dimensions which you can later use to filter, sort, and group your events in the dashboard.
In this guide, you'll learn to:
- Send predefined events
- Send custom events
- Await the results of publishing events
Publish a predefined user event
With our SDK, you can send predefined events to your justtrack account. These events are defined by justtrack and are given special attention in the platform. For example, some metrics are calculated for you if you send data in certain predefined events.
You can find our list of predefined events here.
To send a predefined event, you first create an event object:
const event = new JtLevelStartEvent('LEVEL_1');
Here, JtLevelStartEvent
is a subclass of UserEvent
. It represents a JtLevelStart and accepts a single predefined dimension, called jt_level_name
. In this example, you pass the value for that dimension in the constructor.
You can add more dimensions with .addDimension()
:
const event = new JtLevelStartEvent('LEVEL_1');
event.addDimension('dimension_name', 'value');
You can pass all predefined dimensions that belong to a predefined event to the constructor. For all other dimensions, you must use .addDimension()
.
When you've created and configured an event object, call .publishEvent()
:
await JustTrackSdk.publishEvent(event);
This sends the event to the justtrack platform where you can visualize and analyze your data.
Publish a custom user event
Along with predefined events, you can also send custom events to your justtrack account. You define these events yourself and they're not given any special attention in the platform.
To send a custom event, you first create an event object:
const customEvent = new UserEvent('custom_event_name');
Here, you create a custom UserEvent
object and supply an event name, my_event
.
You can add dimensions to your custom event with .addDimension()
:
const customEvent = new UserEvent('custom_event_name');
customEvent.addDimension('dimension_name', 'value');
When you've created and configured an event object, call .publishEvent()
:
await JustTrackSdk.publishEvent(customEvent);
This sends the event to the justtrack platform where you can visualize and analyze your data.
Conclusion
Now that you know how to send events to your justtrack account, you can review further details of the UserEvent
class in our UserEvent API documentation.