Fields and Enums Reference

Fields

Note: See "Required Fields Table" for an overview of what other column values are expected in certain situations (e.g. all "interactions" will also come with "category" and "actionType" values)

Available Fields

Field	Type	Description
trackTimestamp	timestamp	Time
eventId	unsigned integer	StreamLayer event id
organizationId	string	Organization id
userId	string	StreamLayer user id
userExternalId	string	User id on external system
deviceId	string	User device id
deviceName	string	User device name
sessionId	string	User session id
overlaySessionId	string	StreamLayer overlay session id
topicId	string	ID of the chat or question
os	string full os name	Version of the Operating System of the device
osName	string os family	Name of the Operating System of the device
userAgent	string client user agent	Device metadata
slSdkVersion	string	Client SDK version
slProtofilesVersion	string client	SDK protofiles version
routeMap	string
participantsCount	unsigned integer	Number of participants at the time of event in question
actionType	Action Type	General action type
permission	Permission	General permission
category	Category	General category
kind	Kind	General kind
notification	Notification Kind	Additional kind for notification
notificationType	Notification Type	Additional type for notification
screenOrientation	Screen Orientation	Device screen orientation
topicType	Topic Type	General topic type
parentTopicId	string	Parent topic id
parentTopicType	Topic Type	Parent topic type
pollOpenedFrom	Poll Opened From	Poll opened from
from	From	Invitation from

Required Fields Table

Important: All fields should be considered as optional if they do not have a "+" in the table below. The fields eventId and deviceId are required for all kind values.

kind	category	actionType	participantsCount	permission	notificationType
VIEWERS	+
EVENT_OPENED
LAUNCH_BUTTON
INTERACTIONS	+	+
AUTHENTICATION_ATTEMPTED
AUTHENTICATION_COMPLETED
PERMISSION_PROVIDED				+
PERMISSION_NOT_PROVIDED				+
CONVERSATION_CREATED	+		+
CONVERSATION_JOINED
CONVERSATION_DELETED	+		+
NEW_CALL	+		+
CALL_JOINED
CALL_FINISHED	+		+
INVITATION_SENT	+
INVITATION_ACCEPTED
WAVES_SENT	+
WAVES_REPLIES
NOTIFICATION_RECEIVED	+	+			+
NOTIFICATION_OPENED	+	+			+
SESSION_HEARTBEAT	+
CONVERSATION_OPENED	+		+
GROUP_CONVERSATION_OPENED	+		+
GROUP_CALL_JOINED	+		+
POLLS_VOTE	+
POLLS_RECEIVED	+
POLLS_OPENED	+
GAMES_JOINED	+

Enums

Enum Kind

All enums values are of unsigned integer type

Value	Name	Description
1	VIEWERS	Initialization of the SDK button after user opened a new stream
2	EVENT_OPENED	Deprecated
3	AUTHENTICATION_ATTEMPTED	Authentication attempt sent
4	AUTHENTICATION_COMPLETED	Authentication attempt completed
5	LAUNCH_BUTTON	The launch button has been activated
6	PERMISSION_PROVIDED	Permission request accepted
7	PERMISSION_NOT_PROVIDED	Permission request has been declined
8	INTERACTIONS	Any interaction with the overlay besides the launch button
9	CONVERSATION_CREATED	A new conversation has been created
10	CONVERSATION_JOINED	The user has joined a conversation
11	CONVERSATION_DELETED	The conversation has been deleted
12	NEW_CALL	A call has been created
13	CALL_JOINED	A call has been joined
14	CALL_FINISHED	A call has finished
15	INVITATION_SENT	An invitation has been sent
16	INVITATION_ACCEPTED	An invitation has been accepted
17	WAVES_SENT	A ping has been sent
18	WAVES_REPLIES	A ping has been replied
19	NOTIFICATION_RECEIVED	A notification has been received
20	NOTIFICATION_OPENED	A notification has been opened
21	SESSION_HEARTBEAT	A regular track (heartbeat) is sent every 5 seconds while the user is watching an event
22	CONVERSATION_OPENED	The 1-1 chat (UI screen) has been opened
23	GROUP_CONVERSATION_OPENED	The group chat (UI screen) has been opened
24	GROUP_CALL_JOINED	A group call has been joined
25	KIND_POLLS_VOTE	The user has voted in a poll
26	KIND_POLLS_RECEIVED	The user has received a poll
27	KIND_POLLS_OPENED	The user has opened a poll
28	KIND_GAMES_JOINED	A game has been joined

Enum Screen Orientation

Value	Name	Description
0	UNSET	Empty value
1	PORTRAIT	Portrait orientation
2	LANDSCAPE	Landscape orientation

Enum Category

Value	Name	Description
0	UNSET	Empty value
1	STATS_HOME	Leaderboard screen initialization
2	STATS	Leaderboard screen
3	TWITTER_HOME	Twitter screen initialization
4	TWITTER	Twitter screen
5	MESSAGING_HOME	Messaging screen initialization
6	MESSAGING	Messaging screen
7	CALLING_HOME	Calling screen initialization
8	CALLING	Calling screen
9	PROFILE_HOME	Profile screen initialization
10	PROFILE	Profile screen
11	WHOISWATCHING	Who's watching screen
12	WHOISWATCHING_HOME	Who's watching screen initialization
13	INTERSTITIAL	Interstitial screen
14	BETTING	Betting screen
15	BETTING_HOME	Betting screen initialization
16	INPLAY	Inplay screen
17	INPLAY_HOME	Inplay screen initialization
18	MERCHANDISE	Merchandise screen
19	MERCHANDISE_HOME	Merchandise screen initialization
20	CONTESTS	Contests screen
21	CONTESTS_HOME	Contests screen initialization
22	TICKETS	Tickets screen
23	TICKETS_HOME	Tickets screen initialization
24	INVITATION	Invitation screen
25	INVITATION_HOME	Invitation screen initialization
26	POLLS	Polls screen
27	POLLS_HOME	Polls screen initialization
28	FANTASY	Fantasy screen
29	WP	Watch party screen
30	HIGHLIGHTS_HOME	Highlights screen initialization
31	HIGHLIGHTS	Highlights screen

Enum Notification Kind

Value	Name	Description
0	UNSET	Empty value
1	MESSAGE	Message notification
2	CALL	Call notification
3	TWITTER	Twitter notification
4	WAVE	Ping notification
5	INPLAY	Deprecated
6	GROUP_CALL	Group call notification
7	MISSED_CALL	Missed call notification
8	MISSED_GROUP_CALL	Missed group call notification
9	WATCH_PARTY	Watch party notification
10	POLLS	Polls notification

Enum Notification Type

Value	Name	Description
0	UNSET	Empty value
1	IN_APP	In-app notification
2	PUSH	Push notification

Enum Action Type

Value	Name	Description
0	UNSET	Empty value
1	TAP	Tap event
2	CALL	Call event
3	MESSAGE	Message event
4	SCROLL	Scroll event

Enum Permission

Value	Name	Description
0	UNSET	Empty value
1	ADDRESS_BOOK	Allow read contacts
2	CALLING	Allow calls
3	CAMERA	Allow take photos and shoot videos

Enum Poll Opened From

Value	Name	Description
0	UNSET	Empty value
1	IN_APP	Opened from in-app notification
2	HISTORY	Deprecated
3	PICK_HISTORY	Opened from pick history
4	INSIGHT_HISTORY	Opened from insight history
5	TWEETS_HISTORY	Opened from tweets history

Enum From

Value	Name	Description
0	UNSET	Empty value
1	TITLE_CARD	The invitation comes from the title card
2	MENU	The invitation comes from the menu

Enum Topic Type

Value	Name	Description
0	UNSET	Empty value
1	CALL	The topic is a call
2	CHAT	The topic is a chat
3	FANTASY	The topic is a fantasy
4	POLLS	Deprecated
5	POLLS_POLL	The topic is a poll
6	POLLS_TRIVIA	The topic is a trivia
7	POLLS_PREDICTION	The topic is a prediction
8	POLLS_INSIGHT	The topic is an insight
9	POLLS_TWITTER	The topic is a tweet
10	LINK	The topic is a link
11	MESSAGE	The topic is a message

Enum Invitation Category

When Enum Kind in (15,16), these are the values for Enum Category

Value	Name	Description
0	UNSET	Empty value
1	WATCHING	The invitation is for watching
2	MESSAGING	The invitation is for messaging
3	VOICING	The invitation is for voicing
4	GAMES	The invitation is for games

Enum Waves Sent

When Enum Kind in (17,18), these are the values for Enum Category

Value	Name	Description
0	UNSET	Empty value
1	WATCHING	The wave is for watching
2	MESSAGING	The wave is for messaging
3	VOICING	The wave is for voicing