From ef5ed88355514b07c439f744c4ae4d4c13f5e499 Mon Sep 17 00:00:00 2001 From: RiotRobot Date: Fri, 3 Nov 2023 10:53:02 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20matrix-o?= =?UTF-8?q?rg/matrix-analytics-events@cd6d1f5b9891aeb4c22742a3bf117d741d89?= =?UTF-8?q?67b9=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 2250 ++++++++++++++++++++++++++-------------------------- 1 file changed, 1125 insertions(+), 1125 deletions(-) diff --git a/index.html b/index.html index 73cc308..7ccbe5e 100644 --- a/index.html +++ b/index.html @@ -33,8 +33,8 @@

Analytics events for Element clients

-

PollEnd

-

Triggered when a poll has been ended.

+

JoinedRoom

+

Triggered when the user joins a room.

@@ -46,8 +46,8 @@

PollEnd

- - + + - -
doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without proprties other than the event name.isDMWhether the room is a DM. boolean @@ -55,95 +55,116 @@

PollEnd
-
- -
-

PerformanceTimer

-

Triggered after timing an operation in the app.

- - - - - - - - - - - - + + - - + + - - + + + +
PropertyDescriptionType
contextClient defined, can be used for debugging.isSpaceWhether the room is a Space. - string + boolean
itemCountClient defined, an optional value to indicate how many items were handled during the operation.roomSizeThe size of the room. - - integer + +
    + +
  • + + One + +
    • + +
  • + + Two + +
    • + +
  • + + ThreeToTen + +
    • + +
  • + + ElevenToOneHundred + +
    • + +
  • + + OneHundredAndOneToAThousand + +
    • + +
  • + + MoreThanAThousand + +
    • + +
nameThe timer that is being reported.triggerThe trigger for a room being joined if known.
  • - StartupInitialSync: The duration of an initial /sync request during startup (if the store has been wiped). In this case, `itemCount` should contain the number of joined rooms. + Invite: Room joined via an invite.
  • - StartupIncrementalSync: The duration of a regular /sync request when resuming the app. In this case, `itemCount` should contain the number of joined rooms in the response. + RoomPreview: Room joined via its preview.
  • - StartupStorePreload: The time to preload data in the MXStore on iOS. In this case, `itemCount` should contain the number of rooms in the store. + SlashCommand: Room joined via the /join slash command.
  • - StartupStoreReady: The time to load all data from the store (including StartupStorePreload time). In this case, `itemCount` should contain the number of rooms loaded into the session + RoomDirectory: Room joined via the public rooms directory.
  • - StartupLaunchScreen: How long the app launch screen is displayed for. + SpaceHierarchy: Room joined via the space hierarchy view.
  • - InitialSyncRequest: The time spent waiting for a response to an initial /sync request. In this case, `itemCount` should contain the number of joined rooms. + Timeline: Room joined via a timeline pill or link in another room.
  • - InitialSyncParsing: The time spent parsing the response from an initial /sync request. In this case, `itemCount` should contain the number of joined rooms. + Notification: Room joined via a push/desktop notification.
  • - NotificationsOpenEvent: The time taken to display an event in the timeline that was opened from a notification. + MobilePermalink: Room joined via link.
    • @@ -152,12 +173,29 @@

    PerformanceTimer
+
+ +
+

CreatedRoom

+

Triggered when the user creates a room.

+ + + + + + + + + + - - + + @@ -167,8 +205,8 @@

PerformanceTimer

-

CallEnded

-

Triggered when a call has ended.

+

PermissionChanged

+

Triggered when the user changes a permission status.

PropertyDescriptionType
timeMsThe time reported by the timer in milliseconds.isDMWhether the room is a DM. - integer + boolean
@@ -180,15 +218,50 @@

CallEnded

- - + + + + + + + + + +
durationMsThe duration of the call in milliseconds.grantedWhether the permission has been granted by the user. - integer + boolean + +
permissionThe name of the permission. + +
    + +
  • + + Notification: Permissions related to sending notifications have changed. + +
    • + +
+
+ +
+

CallStarted

+

Triggered when a call is started.

+ + + + + + + + + + @@ -224,8 +297,8 @@

CallEnded

-

ViewRoom

-

Triggered when the user changes rooms.

+

PollEnd

+

Triggered when a poll has been ended.

PropertyDescriptionType
isVideo Whether its a video call or not.
@@ -237,54 +310,45 @@

ViewRoom

- - + + + +
activeSpaceactive space when user navigated to the room.doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without proprties other than the event name. - -
    - -
  • - - Home: Active space is Home. - -
    • - -
  • - - Private: Active space is a private space. - -
    • - -
  • - - Public: Active space is a public space. - -
    • - -
  • - - Meta: Active space is a meta space. - -
    • - -
+ + boolean
+
+ +
+

CallEnded

+

Triggered when a call has ended.

+ + + + + + + + + + - - + + - - + + - - + + + + + + + + + + + +
PropertyDescriptionType
isDMWhether the room is a DM.durationMsThe duration of the call in milliseconds. - boolean + integer
isSpaceWhether the room is a Space.isVideoWhether its a video call or not. boolean @@ -293,487 +357,410 @@

ViewRoom

triggerThe reason for the room change if known.numParticipantsNumber of participants in the call. - -
    - -
  • - - Created: Room accessed due to being just created. - -
    • - -
  • - - RoomList: Room accessed via the room list. - -
    • - -
  • - - RoomDirectory: Room accessed via the public rooms directory. - -
    • - -
  • + + integer + +
placedWhether this user placed it. + + boolean + +
+
+ +
+

$screen

+

Triggered when the user changed screen on Element Android/iOS.

+ + + + + + + + + + + + + + + + + + + + - - - - - - - - - -
PropertyDescriptionType
durationMsHow long the screen was displayed for in milliseconds. + + integer + +
screenName + +
    + +
  • - SpaceHierarchy: Room accessed via the space hierarchy view. + Home: The Home tab on iOS | possibly the same on Android?
  • - Timeline: Room accessed via a timeline pill or link in another room. + Welcome: The splash screen.
  • - Notification: Room accessed via a push/desktop notification. + Login: The screen that displays the login flow (when the user already has an account).
  • - Tombstone: Room accessed via a tombstone at the bottom of a predecessor room. + ForgotPassword: The form for the forgot password use case.
  • - Predecessor: Room accessed via the predecessor link at the top of the upgraded room. + Register: The screen that displays the registration flow (when the user wants to create an account).
  • - Widget: Room switched due to widget interaction. + Room: The screen that displays the messages and events received in a room.
  • - MessageSearch: Room switched due to user interacting with a message search result. + RoomDetails: The screen shown when tapping the name of a room from the Room screen.
  • - MessageUser: Room switched due to user selecting a user to go to a DM with. + RoomMembers: The screen that displays the list of members that are part of a room.
  • - VerificationRequest: Room switched due to user interacting with incoming verification request. + User: A screen that shows information about a room member.
  • - SlashCommand: Room accessed via a slash command in Element Web/Desktop like /goto. + RoomSearch: The screen that allows you to search for messages/files in a specific room.
  • - Shortcut: Room accessed via a shortcut. + RoomUploads: The screen that allows you to see all of the files sent in a specific room.
  • - WebNotificationPanel: Room accessed via Element Web/Desktop's notification panel. + RoomSettings: The settings screen shown from the Room Details screen.
  • - WebKeyboardShortcut: Room accessed via an Element Web/Desktop keyboard shortcut like go to next room with unread messages. + RoomNotifications: The notifications settings screen shown from the Room Details screen.
  • - WebHorizontalBreadcrumbs: Room accessed via the Element Web/Desktop horizontal breadcrumbs at the top of the room list. + RoomAddresses: The room addresses screen shown from the Room Details screen.
  • - WebVerticalBreadcrumbs: Room accessed via the Element Web/Desktop vertical breadcrumb hover menu. + RoomPermissions: The roles permissions screen shown from the Room Details screen.
  • - WebAcceptCall: Room switched due to accepting a call in a different room in Element Web/Desktop. + RoomDirectory: The screen that lists public rooms for you to discover.
  • - WebDialPad: Room switched due to making a call via the dial pad in Element Web/Desktop. + RoomFilter: The screen that lists all the user's rooms and let them filter the rooms.
  • - WebForwardShortcut: Room accessed via the shortcut in Element Web/Desktop's forward modal. + StartChat: The screen shown to create a new direct room.
  • - WebUnifiedSearch: Room accessed via Element Web/Desktop's Unified Search modal. + CreateRoom: The screen shown to create a new (non-direct) room.
  • - WebPredecessorSettings: Room accessed via the predecessor link in Settings > Advanced in Element Web/Desktop. + DeactivateAccount: The confirmation screen shown before deactivating an account.
  • - WebSpaceContextSwitch: Room switched due to the user changing space in Element Web/Desktop. + Group: Legacy: The screen that shows information about a specific group.
  • - WebRoomListNotificationBadge: Room accessed via clicking on a notifications badge on a room list sublist in Element Web/Desktop. + MyGroups: Legacy: The screen that shows all groups/communities you have joined.
  • - WebSpacePanelNotificationBadge: Room accessed via clicking on the notifications badge on the currently selected space in Element Web/Desktop. + SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space.
  • - WebFloatingCallWindow: Room accessed via interacting with the floating call or Jitsi PIP in Element Web/Desktop. + Sidebar: The sidebar shown on mobile with spaces, settings etc.
  • - MobileFileSearch: Room switched due to user interacting with a file search result. + Favourites: The Favourites tab on mobile that lists your favourite people/rooms.
  • - MobileRoomSearch: Room switched due to user interacting with a room search result. + People: The People tab on mobile that lists all the DM rooms you have joined.
  • - MobileSearchContactDetail: Room accessed via interacting with direct chat item in the search contact detail screen. + Rooms: The Rooms tab on mobile that lists all the (non-direct) rooms you've joined.
  • - MobileRoomMemberDetail: Room accessed via interacting with direct chat item in the room contact detail screen. + Dialpad: The tab on mobile that displays the dialpad.
  • - MobileSpaceMemberDetail: Room accessed via interacting with direct chat item in the space contact detail screen. + SearchRooms: The Rooms tab shown in the global search screen on Mobile.
  • - MobileInCall: Room accessed via interacting with the incall screen. + SearchMessages: The Messages tab shown in the global search screen on Mobile.
  • - MobileSpaceMenu: Space accessed via interacting with the space menu. + SearchPeople: The People tab shown in the global search screen on Mobile.
  • - MobileSpaceSettings: Space accessed via interacting with a space settings menu item. + SearchFiles: The Files tab shown in the global search screen on Mobile.
  • - MobileRoomPreview: Room accessed via preview. + SwitchDirectory: The screen shown to select which room directory you'd like to use.
  • - MobilePermalink: Room accessed via link. + InviteFriends: The screen shown to share a link to download the app.
  • - MobileLinkShare: Room accessed during external sharing. + Breadcrumbs: The screen that displays the user's breadcrumbs.
  • - MobileExploreRooms: Room accessed via space explore. + Settings: The global settings screen shown in the app.
  • - MobileSpaceMembers: Room accessed via space members list. + SettingsSecurity: The global security settings screen.
  • - MobileSpaceBottomSheet: Room accessed via space bottom sheet list. + SettingsDefaultNotifications: The settings screen to change the default notification options.
    • -
- -
viaKeyboardWhether the interaction was performed via the keyboard input. - - boolean - -
-
- -
-

JoinedRoom

-

Triggered when the user joins a room.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescriptionType
isDMWhether the room is a DM. - - boolean - -
isSpaceWhether the room is a Space. - - boolean - -
roomSizeThe size of the room. - -
    -
  • - One + SettingsGeneral: The settings screen with general profile settings.
  • - Two + SettingsNotifications: The notifications settings screen.
  • - ThreeToTen + SettingsPreferences: The preferences screen (theme, language, editor preferences, etc.
  • - ElevenToOneHundred + SettingsVoiceVideo: The calls settings screen.
  • - OneHundredAndOneToAThousand + SettingsIgnoredUsers: The settings screen with list of the ignored users.
  • - MoreThanAThousand + SettingsLabs: The experimental features settings screen.
    • -
- -
triggerThe trigger for a room being joined if known. - -
    -
  • - Invite: Room joined via an invite. + SettingsAdvanced: The advanced settings screen (developer mode, rageshake, push notification rules).
  • - RoomPreview: Room joined via its preview. + SettingsHelp: The Help and About screen.
  • - SlashCommand: Room joined via the /join slash command. + SettingsLegals: The settings screen with legals information.
  • - RoomDirectory: Room joined via the public rooms directory. + SettingsMentionsAndKeywords: The settings screen to manage notification mentions and keywords.
  • - SpaceHierarchy: Room joined via the space hierarchy view. + SpaceMenu: The bottom sheet that list all space options.
  • - Timeline: Room joined via a timeline pill or link in another room. + SpaceMembers: Screen that displays the list of members of a space.
  • - Notification: Room joined via a push/desktop notification. + RoomPreview: Screen that displays room preview if user hasn't joined yet.
  • - MobilePermalink: Room joined via link. + ThreadList: Screen that displays list of threads for a room.
    • -
- -
-
- -
-

Signup

-

Triggered once onboarding has completed, but only if the user registered a new account.

- - - - - - - - - - - - - -
PropertyDescriptionType
authenticationTypeThe type of authentication that was used to sign up. - -
    -
  • - Password: Registration with a username and password. - -
    • - -
  • - - Apple: Social login using Apple. + SpaceBottomSheet: Room accessed via space bottom sheet list.
  • - Facebook: Social login using Facebook. + Invites: Room accessed via space bottom sheet list.
  • - GitHub: Social login using GitHub. + CreateSpace: The screen shown to create a new space.
  • - GitLab: Social login using GitLab. + LocationSend: The screen shown to share location.
  • - Google: Social login using Google. + LocationView: The screen shown to view a shared location.
  • - SSO: Registration using another SSO provider. + CreatePollView: The screen shown to create a poll.
  • - Other: Registration using some other mechanism such as fallback. + EditPollView: The screen shown to edit a poll.
    • @@ -787,8 +774,8 @@

    Signup

    -

    $screen

    -

    Triggered when the user changed screen on Element Android/iOS.

    +

    $pageview

    +

    Triggered when the user changed screen on Element Web/Desktop

    @@ -800,17 +787,7 @@

    $screen

    - - - - - - - + + + + + + + + + + +
    durationMsHow long the screen was displayed for in milliseconds. - - integer - -
    screenName$current_url @@ -818,7 +795,7 @@

    $screen

  • - Home: The Home tab on iOS | possibly the same on Android? + Home: Home page.
    • @@ -836,13 +813,19 @@

    $screen

  • - ForgotPassword: The form for the forgot password use case. + ForgotPassword: The form for the forgot password use case
  • - Register: The screen that displays the registration flow (when the user wants to create an account). + Register: The screen that displays the registration flow (when the user wants to create an account) + +
    • + +
  • + + UseCaseSelection: The screen where users choose their expected use case for Element.
    • @@ -884,289 +867,392 @@

    $screen

  • - RoomSettings: The settings screen shown from the Room Details screen. + RoomNotifications: The notifications settings screen shown from the Room Details screen.
  • - RoomNotifications: The notifications settings screen shown from the Room Details screen. + RoomDirectory: The screen that lists public rooms for you to discover.
  • - RoomAddresses: The room addresses screen shown from the Room Details screen. + RoomFilter: The screen that lists all the user's rooms and let them filter the rooms.
  • - RoomPermissions: The roles permissions screen shown from the Room Details screen. + StartChat: The screen shown to create a new direct room.
  • - RoomDirectory: The screen that lists public rooms for you to discover. + CreateRoom: The screen shown to create a new (non-direct) room.
  • - RoomFilter: The screen that lists all the user's rooms and let them filter the rooms. + DeactivateAccount: The confirmation screen shown before deactivating an account.
  • - StartChat: The screen shown to create a new direct room. + Group: Legacy: The screen that shows information about a specific group.
  • - CreateRoom: The screen shown to create a new (non-direct) room. + MyGroups: Legacy: The screen that shows all groups/communities you have joined.
  • - DeactivateAccount: The confirmation screen shown before deactivating an account. + SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space
  • - Group: Legacy: The screen that shows information about a specific group. + Loading: Screen showing loading spinner.
  • - MyGroups: Legacy: The screen that shows all groups/communities you have joined. + CompleteSecurity: Screen showing flow to trust this new device with cross-signing.
  • - SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space. + E2ESetup: Screen showing flow to setup SSSS / cross-signing on this account.
  • - Sidebar: The sidebar shown on mobile with spaces, settings etc. + SoftLogout: Screen showing device has been soft logged out by the server.
  • - Favourites: The Favourites tab on mobile that lists your favourite people/rooms. + UserSettings: Screen showing User Settings (unknown tab).
  • - People: The People tab on mobile that lists all the DM rooms you have joined. + UserSettingsGeneral: Screen showing User Settings General Tab.
  • - Rooms: The Rooms tab on mobile that lists all the (non-direct) rooms you've joined. + UserSettingsAppearance: Screen showing User Settings Appearance Tab.
  • - Dialpad: The tab on mobile that displays the dialpad. + UserSettingsNotifications: Screen showing User Settings Notifications Tab.
  • - SearchRooms: The Rooms tab shown in the global search screen on Mobile. + UserSettingsPreferences: Screen showing User Settings Preferences Tab.
  • - SearchMessages: The Messages tab shown in the global search screen on Mobile. + UserSettingsKeyboard: Screen showing User Settings Keyboard Tab.
  • - SearchPeople: The People tab shown in the global search screen on Mobile. + UserSettingsSidebar: Screen showing User Settings Sidebar Tab.
  • - SearchFiles: The Files tab shown in the global search screen on Mobile. + UserSettingsVoiceVideo: Screen showing User Settings Voice & Video Tab.
  • - SwitchDirectory: The screen shown to select which room directory you'd like to use. + UserSettingsSecurityPrivacy: Screen showing User Settings Security & Privacy Tab.
  • - InviteFriends: The screen shown to share a link to download the app. + UserSettingsLabs: Screen showing User Settings Labs Tab.
  • - Breadcrumbs: The screen that displays the user's breadcrumbs. + UserSettingsIgnoredUsers: Screen showing User Settings Ignored Users Tab.
  • - Settings: The global settings screen shown in the app. + UserSettingsHelpAbout: Screen showing User Settings Help & About Tab.
  • - SettingsSecurity: The global security settings screen. + UserSettingMjolnir: Screen showing User Settings Mjolnir (labs) Tab.
  • - SettingsDefaultNotifications: The settings screen to change the default notification options. + UserSettingFlair: Legacy: screen showing User Settings Flair Tab.
  • - SettingsGeneral: The settings screen with general profile settings. + RoomSettings: Screen showing Room Settings (unknown tab).
  • - SettingsNotifications: The notifications settings screen. + RoomSettingsGeneral: Screen showing Room Settings General Tab.
  • - SettingsPreferences: The preferences screen (theme, language, editor preferences, etc. + RoomSettingsSecurityPrivacy: Screen showing Room Settings Security & Privacy Tab.
  • - SettingsVoiceVideo: The calls settings screen. + RoomSettingsRolesPermissions: Screen showing Room Settings Roles & Permissions Tab.
  • - SettingsIgnoredUsers: The settings screen with list of the ignored users. + RoomSettingsNotifications: Screen showing Room Settings Notifications Tab.
  • - SettingsLabs: The experimental features settings screen. + RoomSettingsBridges: Labs: Screen showing Room Settings Bridges Tab.
  • - SettingsAdvanced: The advanced settings screen (developer mode, rageshake, push notification rules). + RoomSettingsAdvanced: Screen showing Room Settings Advanced Tab.
  • - SettingsHelp: The Help and About screen. + UnifiedSearch: Screen showing the new unified search modal (Project Spotlight).
  • - SettingsLegals: The settings screen with legals information. + FavouriteMessages: Screen showing all messages that have been added to favourites.
  • - SettingsMentionsAndKeywords: The settings screen to manage notification mentions and keywords. + ConfirmStartup: Screen showing that the app is already running in another window.
  • - SpaceMenu: The bottom sheet that list all space options. + SessionLockStolen: Screen showing that the app has been started in another window. + +
    • + + + +
    durationMsHow long the screen took to load, if applicable. + + integer + +
    +
    + +
    +

    Error

    +

    Triggered when an error occurred.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDescriptionType
    contextContext - client defined, can be used for debugging. + + string + +
    cryptoModuleWhich crypto module is the client currently using. + +
      + +
    • + + Native: Native / legacy crypto module specific to each platform.
    • - SpaceMembers: Screen that displays the list of members of a space. + Rust: Shared / cross-platform crypto module written in Rust. + +
      • + +
    + +
    domain + +
      + +
    • + + E2EE
    • - RoomPreview: Screen that displays room preview if user hasn't joined yet. + VOIP
    • - ThreadList: Screen that displays list of threads for a room. + TO_DEVICE
      • +
    + +
    name + +
      +
    • - SpaceBottomSheet: Room accessed via space bottom sheet list. + UnknownError
    • - Invites: Room accessed via space bottom sheet list. + OlmIndexError
    • - CreateSpace: The screen shown to create a new space. + OlmKeysNotSentError
    • - LocationSend: The screen shown to share location. + OlmUnspecifiedError
    • - LocationView: The screen shown to view a shared location. + VoipUserHangup
    • - CreatePollView: The screen shown to create a poll. + VoipIceFailed
    • - EditPollView: The screen shown to edit a poll. + VoipInviteTimeout + +
      • + +
    • + + VoipIceTimeout + +
      • + +
    • + + VoipUserMediaFailed + +
      • + +
    • + + ToDeviceFailedToDecrypt
      • @@ -1180,8 +1266,8 @@

      $screen

      -

      UnauthenticatedError

      -

      Triggered when the user becomes unauthenticated without actually clicking sign out(E.g. Due to expiry of an access token without a way to refresh).

      +

      ViewRoom

      +

      Triggered when the user changes rooms.

      @@ -1193,98 +1279,33 @@

      UnauthenticatedError

      - - + + - - - - - - - - - - - - - - - - - - - - - -
      errorCodeThe error code as defined in matrix spec. The source of this error is from the homeserver.activeSpaceactive space when user navigated to the room.
      • - M_UNKNOWN + Home: Active space is Home.
      • - M_FORBIDDEN + Private: Active space is a private space.
      • - M_UNKNOWN_TOKEN - -
        • - -
      - -
      errorReasonThe reason for the error. The source of this error is from the homeserver, the reason can vary and is subject to change so there is no enum of possible values. - - string - -
      refreshTokenAuthWhether the auth mechanism is refresh-token-based. - - boolean - -
      softLogoutWhether a soft logout or hard logout was triggered. - - boolean - -
      -
      - -
      -

      PollCreation

      -

      Triggered when a poll is created or edited.

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      actionWhether this poll has been created or edited. - -
        - -
      • - - Create: Newly created poll + Public: Active space is a public space.
      • - Edit: Edit of an existing poll + Meta: Active space is a meta space.
        • @@ -1294,55 +1315,8 @@

        PollCreation

      isUndisclosedWhether this poll is undisclosed. - - boolean - -
      numberOfAnswersNumber of answers in the poll. - - integer - -
      -
      - -
      -

      Composer

      -

      Triggered when the user sends a message via the composer.

      - - - - - - - - - - - - - - - - - - - + + - - + + - - + + - - - - - - - - - -
      PropertyDescriptionType
      inThreadWhether the user was using the composer inside of a thread. - - boolean - -
      isEditingWhether the user's composer interaction was editing a previously sent event.isDMWhether the room is a DM. boolean @@ -1351,8 +1325,8 @@

      Composer

      isReplyWhether the user's composer interaction was a reply to a previously sent event.isSpaceWhether the room is a Space. boolean @@ -1361,1302 +1335,1243 @@

      Composer

      messageTypeThe type of the message.triggerThe reason for the room change if known.
      • - Text: A text message. - -
        • - -
      • - - LocationPin: A pin drop location message. - -
        • - -
      • - - LocationUser: A user current location message. + Created: Room accessed due to being just created.
      • - Poll: A poll message. + RoomList: Room accessed via the room list.
      • - VoiceMessage: A voice message. + RoomDirectory: Room accessed via the public rooms directory.
        • -
      - -
      startsThreadWhether this message begins a new thread or not. - - boolean - -
      -
      - -
      -

      UserProperties

      -

      The user properties to apply when identifying. This is not an event definition. These properties must all be device independent.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      WebLayoutWhich layout the user is using in Element Web/Desktop. This is known to clobber between devices. - -
        -
      • - IRC: IRC layout. + SpaceHierarchy: Room accessed via the space hierarchy view.
      • - Bubble: Bubble layout. + Timeline: Room accessed via a timeline pill or link in another room.
      • - Group: Modern layout. + Notification: Room accessed via a push/desktop notification.
      • - Compact: Modern layout with compact option enabled. + Tombstone: Room accessed via a tombstone at the bottom of a predecessor room.
        • -
      - -
      WebMetaSpaceFavouritesEnabledWhether the user has the favourites space enabled. - - boolean - -
      WebMetaSpaceHomeAllRoomsWhether the user has the home space set to all rooms. - - boolean - -
      WebMetaSpaceHomeEnabledWhether the user has the home space enabled. - - boolean - -
      WebMetaSpaceOrphansEnabledWhether the user has the other rooms space enabled. - - boolean - -
      WebMetaSpacePeopleEnabledWhether the user has the people space enabled. - - boolean - -
      allChatsActiveFilterThe active filter in the All Chats screen. - -
        -
      • - All: Filters are activated and All is selected. + Predecessor: Room accessed via the predecessor link at the top of the upgraded room.
      • - Unreads: Filters are activated and Unreads is selected. + Widget: Room switched due to widget interaction.
      • - Favourites: Filters are activated and Favourites is selected. + MessageSearch: Room switched due to user interacting with a message search result.
      • - People: Filters are activated and People is selected. + MessageUser: Room switched due to user selecting a user to go to a DM with.
        • -
      - -
      ftueUseCaseSelectionThe selected messaging use case during the onboarding flow. - -
        -
      • - PersonalMessaging: The first option, Friends and family. + VerificationRequest: Room switched due to user interacting with incoming verification request.
      • - WorkMessaging: The second option, Teams. + SlashCommand: Room accessed via a slash command in Element Web/Desktop like /goto.
      • - CommunityMessaging: The third option, Communities. + Shortcut: Room accessed via a shortcut.
      • - Skip: The footer option to skip the question. + WebNotificationPanel: Room accessed via Element Web/Desktop's notification panel.
        • -
      - -
      numFavouriteRoomsNumber of joined rooms the user has favourited. - - integer - -
      numSpacesNumber of spaces (and sub-spaces) the user is joined to. - - integer - -
      -
      - -
      -

      WebSearch

      -

      Triggered when the user searches rooms.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      numResultsHow many results the user got to their query. - - integer - -
      queryLengthThe length of the user's query. - - integer - -
      viaSpotlightWhether the user is using the new search experience beta. - - boolean - -
      -
      - -
      -

      PermissionChanged

      -

      Triggered when the user changes a permission status.

      - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      grantedWhether the permission has been granted by the user. - - boolean - -
      permissionThe name of the permission. - -
        -
      • - Notification: Permissions related to sending notifications have changed. + WebKeyboardShortcut: Room accessed via an Element Web/Desktop keyboard shortcut like go to next room with unread messages.
        • -
      - -
      -
      - -
      -

      Interaction

      -

      Triggered when the user clicks/taps/activates a UI element.

      - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + +
      PropertyDescriptionType
      indexThe index of the element, if its in a list of elements. - - integer - -
      interactionTypeThe manner with which the user activated the UI element. - -
        -
      • - Pointer + WebHorizontalBreadcrumbs: Room accessed via the Element Web/Desktop horizontal breadcrumbs at the top of the room list.
      • - Keyboard + WebVerticalBreadcrumbs: Room accessed via the Element Web/Desktop vertical breadcrumb hover menu.
      • - Touch + WebAcceptCall: Room switched due to accepting a call in a different room in Element Web/Desktop.
        • -
      - -
      nameThe unique name of this element. - -
        -
      • - WebRoomListRoomTileContextMenuFavouriteToggle: User adjusted their favourites using the context menu on a room tile in the room list in Element Web/Desktop. + WebDialPad: Room switched due to making a call via the dial pad in Element Web/Desktop.
      • - WebRoomHeaderContextMenuFavouriteToggle: User adjusted their favourites using the context menu on the header of a room in Element Web/Desktop. + WebForwardShortcut: Room accessed via the shortcut in Element Web/Desktop's forward modal.
      • - WebRoomListRoomTileNotificationsMenu: User accessed their room notification settings via the context menu on a room tile in the room list in Element Web/Desktop. + WebUnifiedSearch: Room accessed via Element Web/Desktop's Unified Search modal.
      • - WebRoomHeaderContextMenuNotificationsItem: User accessed their room notification settings via the context menu on the header of a room in Element Web/Desktop. + WebPredecessorSettings: Room accessed via the predecessor link in Settings > Advanced in Element Web/Desktop.
      • - WebRoomHeaderContextMenuPeopleItem: User accessed room member list using the context menu on the header of a room in Element Web/Desktop. + WebSpaceContextSwitch: Room switched due to the user changing space in Element Web/Desktop.
      • - WebRightPanelRoomInfoPeopleButton: User accessed room member list using the 'People' button in the right panel room summary card of Element Web/Desktop. + WebRoomListNotificationBadge: Room accessed via clicking on a notifications badge on a room list sublist in Element Web/Desktop.
      • - WebRightPanelRoomUserInfoBackButton: User accessed room member list using the back button in the right panel user info card of Element Web/Desktop. + WebSpacePanelNotificationBadge: Room accessed via clicking on the notifications badge on the currently selected space in Element Web/Desktop.
      • - WebRoomListRoomTileContextMenuLeaveItem: User interacted with leave action in the context menu on a room tile in the room list in Element Web/Desktop. + WebFloatingCallWindow: Room accessed via interacting with the floating call or Jitsi PIP in Element Web/Desktop.
      • - WebRoomHeaderContextMenuLeaveItem: User interacted with leave action in the context menu on the header of a room in Element Web/Desktop. + MobileFileSearch: Room switched due to user interacting with a file search result.
      • - WebRoomSettingsLeaveButton: User interacted with leave action in the general tab of the room settings dialog in Element Web/Desktop. + MobileRoomSearch: Room switched due to user interacting with a room search result.
      • - WebRoomListRoomTileContextMenuSettingsItem: User accessed room settings using the context menu on a room tile in the room list in Element Web/Desktop. + MobileSearchContactDetail: Room accessed via interacting with direct chat item in the search contact detail screen.
      • - WebRoomHeaderContextMenuSettingsItem: User accessed room settings using the context menu on the header of a room in Element Web/Desktop. + MobileRoomMemberDetail: Room accessed via interacting with direct chat item in the room contact detail screen.
      • - WebRightPanelRoomInfoSettingsButton: User accessed room settings using the 'Settings' button in the right panel room summary card of Element Web/Desktop. + MobileSpaceMemberDetail: Room accessed via interacting with direct chat item in the space contact detail screen.
      • - WebRoomListRoomTileContextMenuInviteItem: User accessed the room invite flow using the context menu on a room tile in the room list in Element Web/Desktop. + MobileInCall: Room accessed via interacting with the incall screen.
      • - WebRoomHeaderContextMenuInviteItem: User accessed the room invite flow using the context menu on the header of a room in Element Web/Desktop. + MobileSpaceMenu: Space accessed via interacting with the space menu.
      • - WebRightPanelMemberListInviteButton: User accessed the room invite flow using the button at the top of the room member list in the right panel of Element Web/Desktop. + MobileSpaceSettings: Space accessed via interacting with a space settings menu item.
      • - WebRightPanelRoomUserInfoInviteButton: User invited someone to room by clicking invite on the right panel user info card in Element Web/Desktop. + MobileRoomPreview: Room accessed via preview.
      • - WebQuickSettingsThemeDropdown: User interacted with the theme dropdown in the quick settings menu of Element Web/Desktop. + MobilePermalink: Room accessed via link.
      • - WebUserMenuThemeToggleButton: User clicked the theme toggle button in the user menu of Element Web/Desktop. + MobileLinkShare: Room accessed during external sharing.
      • - WebSettingsAppearanceTabThemeSelector: User interacted with the theme radio selector in the Appearance tab of Settings in Element Web/Desktop. + MobileExploreRooms: Room accessed via space explore.
      • - WebQuickSettingsPinToSidebarCheckbox: User interacted with pin to sidebar checkboxes in the quick settings menu of Element Web/Desktop. + MobileSpaceMembers: Room accessed via space members list.
      • - WebSettingsSidebarTabSpacesCheckbox: User interacted with the pre-built space checkboxes in the Sidebar tab of Settings in Element Web/Desktop. + MobileSpaceBottomSheet: Room accessed via space bottom sheet list.
        • +
      + +
      viaKeyboardWhether the interaction was performed via the keyboard input. + + boolean + +
      +
      + +
      +

      UserProperties

      +

      The user properties to apply when identifying. This is not an event definition. These properties must all be device independent.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      WebLayoutWhich layout the user is using in Element Web/Desktop. This is known to clobber between devices. + +
        +
      • - WebRoomSettingsSecurityTabCreateNewRoomButton: User interacted with the prompt to create a new room when adjusting security settings in an existing room in Element Web/Desktop. + IRC: IRC layout.
      • - WebHomeCreateRoomButton: User clicked the create room button in the home page of Element Web/Desktop. + Bubble: Bubble layout.
      • - WebRoomDirectoryCreateRoomButton: User clicked the create room button in the room directory of Element Web/Desktop. + Group: Modern layout.
      • - WebRoomListRoomsSublistPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the rooms sublist in Element Web/Desktop. + Compact: Modern layout with compact option enabled.
        • +
      + +
      WebMetaSpaceFavouritesEnabledWhether the user has the favourites space enabled. + + boolean + +
      WebMetaSpaceHomeAllRoomsWhether the user has the home space set to all rooms. + + boolean + +
      WebMetaSpaceHomeEnabledWhether the user has the home space enabled. + + boolean + +
      WebMetaSpaceOrphansEnabledWhether the user has the other rooms space enabled. + + boolean + +
      WebMetaSpacePeopleEnabledWhether the user has the people space enabled. + + boolean + +
      allChatsActiveFilterThe active filter in the All Chats screen. + +
        +
      • - WebRoomListHeaderPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the room list header in Element Web/Desktop. + All: Filters are activated and All is selected.
      • - WebSpaceHomeCreateRoomButton: User clicked the new room button in the context menu on the space home in Element Web/Desktop. + Unreads: Filters are activated and Unreads is selected.
      • - WebSpaceContextMenuNewRoomItem: User clicked the new room button in the context menu of a space in Element Web/Desktop. + Favourites: Filters are activated and Favourites is selected.
      • - WebAddExistingToSpaceDialogCreateRoomButton: User clicked the create room button in the add existing room to space dialog in Element Web/Desktop. + People: Filters are activated and People is selected.
        • +
      + +
      ftueUseCaseSelectionThe selected messaging use case during the onboarding flow. + +
        +
      • - WebHomeCreateChatButton: User clicked the create DM button in the home page of Element Web/Desktop. + PersonalMessaging: The first option, Friends and family.
      • - WebRoomListRoomsSublistPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the rooms sublist in Element Web/Desktop. + WorkMessaging: The second option, Teams.
      • - WebRoomListHeaderPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the room list header in Element Web/Desktop. + CommunityMessaging: The third option, Communities.
      • - WebSpaceContextMenuHomeItem: User clicked the home button in the context menu of a space in Element Web/Desktop. + Skip: The footer option to skip the question.
        • +
      + +
      numFavouriteRoomsNumber of joined rooms the user has favourited. + + integer + +
      numSpacesNumber of spaces (and sub-spaces) the user is joined to. + + integer + +
      +
      + +
      +

      SlashCommand

      +

      Triggered when the user runs a slash command in their composer.

      + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      commandThe name of this command. + +
        +
      • - WebHomeExploreRoomsButton: User clicked the explore rooms button in the home page of Element Web/Desktop. + Part
      • - WebHomeMiniAvatarUploadButton: User clicked on the mini avatar uploader in the home page of Element Web/Desktop. + Invite
        • +
      + +
      +
      + +
      +

      Interaction

      +

      Triggered when the user clicks/taps/activates a UI element.

      + + + + + + + + + + + + + + + + + + + + + + + + + + - - - -
      PropertyDescriptionType
      indexThe index of the element, if its in a list of elements. + + integer + +
      interactionTypeThe manner with which the user activated the UI element. + +
        +
      • - WebProfileSettingsAvatarUploadButton: User clicked on the avatar uploader in the profile settings of Element Web/Desktop. + Pointer
      • - WebLeftPanelExploreRoomsButton: User clicked the explore rooms button next to the search field at the top of the left panel in Element Web/Desktop. + Keyboard
      • - WebSpaceContextMenuExploreRoomsItem: User clicked the explore rooms button in the context menu of a space in Element Web/Desktop. + Touch
        • -
      • - - WebRoomListHeaderPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the room list header in Element Web/Desktop. - -
        • +
      + +
      nameThe unique name of this element. + +
      • - WebRoomListRoomsSublistPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the rooms sublist in Element Web/Desktop. + WebRoomListRoomTileContextMenuFavouriteToggle: User adjusted their favourites using the context menu on a room tile in the room list in Element Web/Desktop.
      • - WebRightPanelThreadPanelFilterDropdown: User clicked the threads 'show' filter dropdown in the threads panel in Element Web/Desktop. + WebRoomHeaderContextMenuFavouriteToggle: User adjusted their favourites using the context menu on the header of a room in Element Web/Desktop.
      • - WebRoomHeaderButtonsThreadsButton: User clicked the Threads button in the top right of a room in Element Web/Desktop. + WebRoomListRoomTileNotificationsMenu: User accessed their room notification settings via the context menu on a room tile in the room list in Element Web/Desktop.
      • - WebThreadViewBackButton: User clicked the back button on a Thread view going back to the Threads Panel of Element Web/Desktop. + WebRoomHeaderContextMenuNotificationsItem: User accessed their room notification settings via the context menu on the header of a room in Element Web/Desktop.
      • - WebThreadsPanelThreadItem: User selected a thread in the Threads panel in Element Web/Desktop. + WebRoomHeaderContextMenuPeopleItem: User accessed room member list using the context menu on the header of a room in Element Web/Desktop.
      • - WebRoomTimelineThreadSummaryButton: User clicked a thread summary in the timeline of a room in Element Web/Desktop. + WebRightPanelRoomInfoPeopleButton: User accessed room member list using the 'People' button in the right panel room summary card of Element Web/Desktop.
      • - WebUserOnboardingHeaderSendDm: User clicked on the send DM CTA in the header of the new user onboarding page in Element Web/Desktop. + WebRightPanelRoomUserInfoBackButton: User accessed room member list using the back button in the right panel user info card of Element Web/Desktop.
      • - WebUserOnboardingTaskSendDm: User clicked on the action of the find people task on the new user onboarding page in Element Web/Desktop. + WebRoomListRoomTileContextMenuLeaveItem: User interacted with leave action in the context menu on a room tile in the room list in Element Web/Desktop.
      • - WebUserOnboardingTaskDownloadApps: User clicked on the action of the download apps task on the new user onboarding page in Element Web/Desktop. + WebRoomHeaderContextMenuLeaveItem: User interacted with leave action in the context menu on the header of a room in Element Web/Desktop.
      • - WebUserOnboardingTaskSetupProfile: User clicked on the action of the your profile task on the new user onboarding page in Element Web/Desktop. + WebRoomSettingsLeaveButton: User interacted with leave action in the general tab of the room settings dialog in Element Web/Desktop.
      • - WebUserOnboardingTaskEnableNotifications: User clicked on the action of the enable notifications task on the new user onboarding page in Element Web/Desktop. + WebRoomListRoomTileContextMenuSettingsItem: User accessed room settings using the context menu on a room tile in the room list in Element Web/Desktop.
      • - WebRoomListUserOnboardingButton: User clicked on the button to return to the user onboarding list in the room list in Element Web/Desktop. + WebRoomHeaderContextMenuSettingsItem: User accessed room settings using the context menu on the header of a room in Element Web/Desktop.
      • - WebRoomListUserOnboardingIgnoreButton: User clicked on the button to close the user onboarding button in the room list in Element Web/Desktop. + WebRightPanelRoomInfoSettingsButton: User accessed room settings using the 'Settings' button in the right panel room summary card of Element Web/Desktop.
      • - SpacePanelSelectedSpace: User tapped the already selected space from the space list. + WebRoomListRoomTileContextMenuInviteItem: User accessed the room invite flow using the context menu on a room tile in the room list in Element Web/Desktop.
      • - SpacePanelSwitchSpace: User tapped an unselected space from the space list -> space switching should occur. + WebRoomHeaderContextMenuInviteItem: User accessed the room invite flow using the context menu on the header of a room in Element Web/Desktop.
      • - SpacePanelSwitchSubSpace: User tapped an unselected sub space from the space list -> space switching should occur. + WebRightPanelMemberListInviteButton: User accessed the room invite flow using the button at the top of the room member list in the right panel of Element Web/Desktop.
      • - MobileRoomLeave: User tapped on Leave Room button on Room Details screen. + WebRightPanelRoomUserInfoInviteButton: User invited someone to room by clicking invite on the right panel user info card in Element Web/Desktop.
      • - MobileRoomAddHome: User tapped on Add to Home button on Room Details screen. + WebQuickSettingsThemeDropdown: User interacted with the theme dropdown in the quick settings menu of Element Web/Desktop.
      • - MobileRoomThreadListButton: User tapped on Threads button on Room screen. + WebUserMenuThemeToggleButton: User clicked the theme toggle button in the user menu of Element Web/Desktop.
      • - MobileRoomThreadSummaryItem: User tapped on a thread summary item on Room screen. + WebSettingsAppearanceTabThemeSelector: User interacted with the theme radio selector in the Appearance tab of Settings in Element Web/Desktop.
      • - MobileThreadListThreadItem: User selected a thread on ThreadList screen. + WebQuickSettingsPinToSidebarCheckbox: User interacted with pin to sidebar checkboxes in the quick settings menu of Element Web/Desktop.
      • - MobileThreadListFilterItem: User tapped on the filter button on ThreadList screen. + WebSettingsSidebarTabSpacesCheckbox: User interacted with the pre-built space checkboxes in the Sidebar tab of Settings in Element Web/Desktop.
      • - MobileAllChatsRecentsEnabled: User enabled recents from the all chats layout settings. + WebRoomSettingsSecurityTabCreateNewRoomButton: User interacted with the prompt to create a new room when adjusting security settings in an existing room in Element Web/Desktop.
      • - MobileAllChatsRecentsDisabled: User disabled recents from the all chats layout settings. + WebHomeCreateRoomButton: User clicked the create room button in the home page of Element Web/Desktop.
      • - MobileAllChatsFiltersEnabled: User enabled filters from the all chats layout settings. + WebRoomDirectoryCreateRoomButton: User clicked the create room button in the room directory of Element Web/Desktop.
      • - MobileAllChatsFiltersDisabled: User disabled filters from the all chats layout settings. + WebRoomListRoomsSublistPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the rooms sublist in Element Web/Desktop.
      • - MobileAllChatsFilterAll: User tapped the All filter in the All Chats filter tab. + WebRoomListHeaderPlusMenuCreateRoomItem: User clicked the create room button in the + context menu of the room list header in Element Web/Desktop.
      • - MobileAllChatsFilterFavourites: User tapped the Favourites filter in the All Chats filter tab. + WebSpaceHomeCreateRoomButton: User clicked the new room button in the context menu on the space home in Element Web/Desktop.
      • - MobileAllChatsFilterUnreads: User tapped the Unreads filter in the All Chats filter tab. + WebSpaceContextMenuNewRoomItem: User clicked the new room button in the context menu of a space in Element Web/Desktop.
      • - MobileAllChatsFilterPeople: User tapped the People filter in the All Chats filter tab. + WebAddExistingToSpaceDialogCreateRoomButton: User clicked the create room button in the add existing room to space dialog in Element Web/Desktop.
      • - MobileSpaceCreationValidated: User validated the creation of a new space. + WebHomeCreateChatButton: User clicked the create DM button in the home page of Element Web/Desktop.
        • -
      - -
      -
      - -
      -

      PollVote

      -

      Triggered when a poll vote has been cast.

      - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without proprties other than the event name. - - boolean - -
      -
      - -
      -

      CallError

      -

      Triggered when an error occurred in a call.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      isVideoWhether its a video call or not. - - boolean - -
      numParticipantsNumber of participants in the call. - - integer - -
      placedWhether this user placed it. - - boolean - -
      -
      - -
      -

      CreatedRoom

      -

      Triggered when the user creates a room.

      - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      isDMWhether the room is a DM. - - boolean - -
      -
      - -
      -

      SlashCommand

      -

      Triggered when the user runs a slash command in their composer.

      - - - - - - - - - - - - - - - - - -
      PropertyDescriptionType
      commandThe name of this command. - -
        -
      • - Part + WebRoomListRoomsSublistPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the rooms sublist in Element Web/Desktop.
      • - Invite + WebRoomListHeaderPlusMenuCreateChatItem: User clicked the create DM button in the + context menu of the room list header in Element Web/Desktop.
        • -
      - -
      -
      - -
      -

      $pageview

      -

      Triggered when the user changed screen on Element Web/Desktop

      - - - - - - - - - - - - - - + + + +
      PropertyDescriptionType
      $current_url - -
        -
      • - Home: Home page. + WebSpaceContextMenuHomeItem: User clicked the home button in the context menu of a space in Element Web/Desktop.
      • - Welcome: The splash screen. + WebHomeExploreRoomsButton: User clicked the explore rooms button in the home page of Element Web/Desktop.
      • - Login: The screen that displays the login flow (when the user already has an account). + WebHomeMiniAvatarUploadButton: User clicked on the mini avatar uploader in the home page of Element Web/Desktop.
      • - ForgotPassword: The form for the forgot password use case + WebProfileSettingsAvatarUploadButton: User clicked on the avatar uploader in the profile settings of Element Web/Desktop.
      • - Register: The screen that displays the registration flow (when the user wants to create an account) + WebLeftPanelExploreRoomsButton: User clicked the explore rooms button next to the search field at the top of the left panel in Element Web/Desktop.
      • - UseCaseSelection: The screen where users choose their expected use case for Element. + WebSpaceContextMenuExploreRoomsItem: User clicked the explore rooms button in the context menu of a space in Element Web/Desktop.
      • - Room: The screen that displays the messages and events received in a room. + WebRoomListHeaderPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the room list header in Element Web/Desktop.
      • - RoomDetails: The screen shown when tapping the name of a room from the Room screen. + WebRoomListRoomsSublistPlusMenuExploreRoomsItem: User clicked the explore rooms button in the + context menu of the rooms sublist in Element Web/Desktop.
      • - RoomMembers: The screen that displays the list of members that are part of a room. + WebRightPanelThreadPanelFilterDropdown: User clicked the threads 'show' filter dropdown in the threads panel in Element Web/Desktop.
      • - User: A screen that shows information about a room member. + WebRoomHeaderButtonsThreadsButton: User clicked the Threads button in the top right of a room in Element Web/Desktop.
      • - RoomSearch: The screen that allows you to search for messages/files in a specific room. + WebThreadViewBackButton: User clicked the back button on a Thread view going back to the Threads Panel of Element Web/Desktop.
      • - RoomUploads: The screen that allows you to see all of the files sent in a specific room. + WebThreadsPanelThreadItem: User selected a thread in the Threads panel in Element Web/Desktop.
      • - RoomNotifications: The notifications settings screen shown from the Room Details screen. + WebRoomTimelineThreadSummaryButton: User clicked a thread summary in the timeline of a room in Element Web/Desktop.
      • - RoomDirectory: The screen that lists public rooms for you to discover. + WebUserOnboardingHeaderSendDm: User clicked on the send DM CTA in the header of the new user onboarding page in Element Web/Desktop.
      • - RoomFilter: The screen that lists all the user's rooms and let them filter the rooms. + WebUserOnboardingTaskSendDm: User clicked on the action of the find people task on the new user onboarding page in Element Web/Desktop.
      • - StartChat: The screen shown to create a new direct room. + WebUserOnboardingTaskDownloadApps: User clicked on the action of the download apps task on the new user onboarding page in Element Web/Desktop.
      • - CreateRoom: The screen shown to create a new (non-direct) room. + WebUserOnboardingTaskSetupProfile: User clicked on the action of the your profile task on the new user onboarding page in Element Web/Desktop.
      • - DeactivateAccount: The confirmation screen shown before deactivating an account. + WebUserOnboardingTaskEnableNotifications: User clicked on the action of the enable notifications task on the new user onboarding page in Element Web/Desktop.
      • - Group: Legacy: The screen that shows information about a specific group. + WebRoomListUserOnboardingButton: User clicked on the button to return to the user onboarding list in the room list in Element Web/Desktop.
      • - MyGroups: Legacy: The screen that shows all groups/communities you have joined. + WebRoomListUserOnboardingIgnoreButton: User clicked on the button to close the user onboarding button in the room list in Element Web/Desktop.
      • - SpaceExploreRooms: Screen that displays the list of rooms and spaces of a space + SpacePanelSelectedSpace: User tapped the already selected space from the space list.
      • - Loading: Screen showing loading spinner. + SpacePanelSwitchSpace: User tapped an unselected space from the space list -> space switching should occur.
      • - CompleteSecurity: Screen showing flow to trust this new device with cross-signing. + SpacePanelSwitchSubSpace: User tapped an unselected sub space from the space list -> space switching should occur.
      • - E2ESetup: Screen showing flow to setup SSSS / cross-signing on this account. + MobileRoomLeave: User tapped on Leave Room button on Room Details screen.
      • - SoftLogout: Screen showing device has been soft logged out by the server. + MobileRoomAddHome: User tapped on Add to Home button on Room Details screen.
      • - UserSettings: Screen showing User Settings (unknown tab). + MobileRoomThreadListButton: User tapped on Threads button on Room screen.
      • - UserSettingsGeneral: Screen showing User Settings General Tab. + MobileRoomThreadSummaryItem: User tapped on a thread summary item on Room screen.
      • - UserSettingsAppearance: Screen showing User Settings Appearance Tab. + MobileThreadListThreadItem: User selected a thread on ThreadList screen.
      • - UserSettingsNotifications: Screen showing User Settings Notifications Tab. + MobileThreadListFilterItem: User tapped on the filter button on ThreadList screen.
      • - UserSettingsPreferences: Screen showing User Settings Preferences Tab. + MobileAllChatsRecentsEnabled: User enabled recents from the all chats layout settings.
      • - UserSettingsKeyboard: Screen showing User Settings Keyboard Tab. + MobileAllChatsRecentsDisabled: User disabled recents from the all chats layout settings.
      • - UserSettingsSidebar: Screen showing User Settings Sidebar Tab. + MobileAllChatsFiltersEnabled: User enabled filters from the all chats layout settings.
      • - UserSettingsVoiceVideo: Screen showing User Settings Voice & Video Tab. + MobileAllChatsFiltersDisabled: User disabled filters from the all chats layout settings.
      • - UserSettingsSecurityPrivacy: Screen showing User Settings Security & Privacy Tab. + MobileAllChatsFilterAll: User tapped the All filter in the All Chats filter tab.
      • - UserSettingsLabs: Screen showing User Settings Labs Tab. + MobileAllChatsFilterFavourites: User tapped the Favourites filter in the All Chats filter tab.
      • - UserSettingsIgnoredUsers: Screen showing User Settings Ignored Users Tab. + MobileAllChatsFilterUnreads: User tapped the Unreads filter in the All Chats filter tab.
      • - UserSettingsHelpAbout: Screen showing User Settings Help & About Tab. + MobileAllChatsFilterPeople: User tapped the People filter in the All Chats filter tab.
      • - UserSettingMjolnir: Screen showing User Settings Mjolnir (labs) Tab. + MobileSpaceCreationValidated: User validated the creation of a new space.
        • +
      + +
      +
      + +
      +

      PerformanceTimer

      +

      Triggered after timing an operation in the app.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      contextClient defined, can be used for debugging. + + string + +
      itemCountClient defined, an optional value to indicate how many items were handled during the operation. + + integer + +
      nameThe timer that is being reported. + +
        +
      • - UserSettingFlair: Legacy: screen showing User Settings Flair Tab. + StartupInitialSync: The duration of an initial /sync request during startup (if the store has been wiped). In this case, `itemCount` should contain the number of joined rooms.
      • - RoomSettings: Screen showing Room Settings (unknown tab). + StartupIncrementalSync: The duration of a regular /sync request when resuming the app. In this case, `itemCount` should contain the number of joined rooms in the response.
      • - RoomSettingsGeneral: Screen showing Room Settings General Tab. + StartupStorePreload: The time to preload data in the MXStore on iOS. In this case, `itemCount` should contain the number of rooms in the store.
      • - RoomSettingsSecurityPrivacy: Screen showing Room Settings Security & Privacy Tab. + StartupStoreReady: The time to load all data from the store (including StartupStorePreload time). In this case, `itemCount` should contain the number of rooms loaded into the session
      • - RoomSettingsRolesPermissions: Screen showing Room Settings Roles & Permissions Tab. + StartupLaunchScreen: How long the app launch screen is displayed for.
      • - RoomSettingsNotifications: Screen showing Room Settings Notifications Tab. + InitialSyncRequest: The time spent waiting for a response to an initial /sync request. In this case, `itemCount` should contain the number of joined rooms.
      • - RoomSettingsBridges: Labs: Screen showing Room Settings Bridges Tab. + InitialSyncParsing: The time spent parsing the response from an initial /sync request. In this case, `itemCount` should contain the number of joined rooms.
      • - RoomSettingsAdvanced: Screen showing Room Settings Advanced Tab. + NotificationsOpenEvent: The time taken to display an event in the timeline that was opened from a notification. + +
        • + +
      + +
      timeMsThe time reported by the timer in milliseconds. + + integer + +
      +
      + +
      +

      Composer

      +

      Triggered when the user sends a message via the composer.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      inThreadWhether the user was using the composer inside of a thread. + + boolean + +
      isEditingWhether the user's composer interaction was editing a previously sent event. + + boolean + +
      isReplyWhether the user's composer interaction was a reply to a previously sent event. + + boolean + +
      messageTypeThe type of the message. + +
        + +
      • + + Text: A text message.
      • - UnifiedSearch: Screen showing the new unified search modal (Project Spotlight). + LocationPin: A pin drop location message.
      • - FavouriteMessages: Screen showing all messages that have been added to favourites. + LocationUser: A user current location message. + +
        • + +
      • + + Poll: A poll message. + +
        • + +
      • + + VoiceMessage: A voice message.
        • +
      + +
      startsThreadWhether this message begins a new thread or not. + + boolean + +
      +
      + +
      +

      PollCreation

      +

      Triggered when a poll is created or edited.

      + + + + + + + + + + + + + + - - + + + + + + + +
      PropertyDescriptionType
      actionWhether this poll has been created or edited. + +
        +
      • - ConfirmStartup: Screen showing that the app is already running in another window. + Create: Newly created poll
      • - SessionLockStolen: Screen showing that the app has been started in another window. + Edit: Edit of an existing poll
        • @@ -2666,8 +2581,18 @@

        $pageview

      durationMsHow long the screen took to load, if applicable.isUndisclosedWhether this poll is undisclosed. + + boolean + +
      numberOfAnswersNumber of answers in the poll. integer @@ -2680,8 +2605,8 @@

      $pageview

      -

      CallStarted

      -

      Triggered when a call is started.

      +

      CallError

      +

      Triggered when an error occurred in a call.

      @@ -2727,8 +2652,8 @@

      CallStarted

      -

      Error

      -

      Triggered when an error occurred.

      +

      Signup

      +

      Triggered once onboarding has completed, but only if the user registered a new account.

      @@ -2740,133 +2665,104 @@

      Error

      - - - - - - - - - - - - - - + + - - - - - - + + + +
      contextContext - client defined, can be used for debugging. - - string - -
      cryptoModuleWhich crypto module is the client currently using. - -
        - -
      • - - Native: Native / legacy crypto module specific to each platform. - -
        • - -
      • - - Rust: Shared / cross-platform crypto module written in Rust. - -
        • - -
      - -
      domainauthenticationTypeThe type of authentication that was used to sign up.
      • - E2EE - -
        • - -
      • - - VOIP + Password: Registration with a username and password.
      • - TO_DEVICE + Apple: Social login using Apple.
        • -
      - -
      name - -
        -
      • - UnknownError + Facebook: Social login using Facebook.
      • - OlmIndexError + GitHub: Social login using GitHub.
      • - OlmKeysNotSentError + GitLab: Social login using GitLab.
      • - OlmUnspecifiedError + Google: Social login using Google.
      • - VoipUserHangup + SSO: Registration using another SSO provider.
      • - VoipIceFailed + Other: Registration using some other mechanism such as fallback.
        • -
      • - - VoipInviteTimeout - -
        • +
      + +
      +
      + +
      +

      UnauthenticatedError

      +

      Triggered when the user becomes unauthenticated without actually clicking sign out(E.g. Due to expiry of an access token without a way to refresh).

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      errorCodeThe error code as defined in matrix spec. The source of this error is from the homeserver. + +
      • - VoipIceTimeout + M_UNKNOWN
      • - VoipUserMediaFailed + M_FORBIDDEN
      • - ToDeviceFailedToDecrypt + M_UNKNOWN_TOKEN
        • @@ -2875,6 +2771,110 @@

        Error
      errorReasonThe reason for the error. The source of this error is from the homeserver, the reason can vary and is subject to change so there is no enum of possible values. + + string + +
      refreshTokenAuthWhether the auth mechanism is refresh-token-based. + + boolean + +
      softLogoutWhether a soft logout or hard logout was triggered. + + boolean + +
      +
      + +
      +

      PollVote

      +

      Triggered when a poll vote has been cast.

      + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      doNotUseDo not use this. Remove this property when the kotlin type generator can properly generate types without proprties other than the event name. + + boolean + +
      +
      + +
      +

      WebSearch

      +

      Triggered when the user searches rooms.

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      PropertyDescriptionType
      numResultsHow many results the user got to their query. + + integer + +
      queryLengthThe length of the user's query. + + integer + +
      viaSpotlightWhether the user is using the new search experience beta. + + boolean + +