Page tree
Skip to end of metadata
Go to start of metadata

What are events?

The data collected by this app relies on events. An event is an action which was performed by a user.

We distinguish between two kinds of collected data: "view" and "interaction".

View data

View data is used to monitor certain events which are observed over a span of time. Such events could be "loading time" or "average time spent using the app".

Interaction data

An interaction is a single one-off action which must be triggered. A click on a button or a link are examples for interaction data.



What kind of data can be collected?

Only data conforming to a fixed JSON schema can be written to the database. This means that the database won't accept any data which is not defined in the code you see below.

Any other information communicated by the browser can neither be stored nor saved or transmitted anywhere in any form.


The JSON schema used by Linchpin App Usage:

JSON Schema
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://usage.seibert-media.io/event.json",
  "type": "object",
  "title": "The JSON Schema for validating events sent to usage.seibert-media.io",
  "required": ["metadata", "events", "apps"],
  "properties": {
    "metadata": {
      "type": "object",
      "required": ["sessionID", "environment"],
      "properties": {
        "sessionID": {
          "type": "string",
          "description": "A unique sessionID to link events"
        },
        "environment": {
          "type": "object",
          "required": ["browser", "resolution", "hostVersion", "maxUsers"],
          "properties": {
            "browser": {
              "type": "string"
            },
            "resolution": {
              "type": "string"
            },
            "hostVersion": {
              "type": "string"
            },
            "maxUsers": {
              "type": "integer"
            }
          }
        }
      }
    },
    "apps": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "required": ["version"],
        "properties": {
          "sen": {
            "type": "string"
          },
          "version": {
            "type": "string"
          }
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["kind", "name", "timestamp", "app"],
        "if": {
          "properties": { "kind": { "const": "view" } }
        },
        "then": {
          "required": ["kind", "name", "timestamp", "app", "loadDuration"]
        },
        "properties": {
          "kind": {
            "enum": ["view", "interaction"]
          },
          "name": {
            "type": "string"
          },
          "timestamp": {
            "type": "string"
          },
          "app": {
            "type": "string"
          },
          "loadDuration": {
            "type": "number"
          },
          "data": {
            "type": "object",
            "required": [],
            "properties": {},
            "additionalProperties": true
          }
        }
      }
    }
  }
}

Navigation


Back to Linchpin App Usage documentation







 Language Manager

Event

Technical event name

viewing the space language settings

space-language-settings

viewing the page language dialog

page-language-dialog

viewing the notice to reindex after plugin activation

redindex-after-plugin-activation-flag

viewing a page with an available language select

page-with-language-select

viewing a hint flag to a page with the user's language

page-language-hint-flag

setting a language to a space with the language code in the value

set-space-language

closing the hint to a page in the user's language without changing the page

close-page-hint

switching to the page in the hint to a page in the user's language

switch-to-page-by-hint

switching to a page by using the language dropdown in a page

switch-to-page-by-dropdown

linking a page to other pages with the number of links in the value

link-page

 Linchpin App Usage

Event

Technical event name

viewing the usage settings

global-settings

when disabling the app usage

usage-disabled

 Linchpin Enterprise News
EventTechnical event name
On publishing news: which type of news-teaser is selected?
newsteaser
 Linchpin Events

Linchpin Events

Eve

nt

Technical event name
Click the button to create a new event in the Event hub
le-portal-create-event
Display the event hub
le-event-hub
Display the dialogue for creating a new event
le-create-event
Click the "Show more" button in the event hub to load more results
le-event-hub-load-more
Set a category filter in the event hub by clicking an entry in the left sidebar
le-event-hub-click-on-category
Click the "All events" entry in the left sidebar
le-event-hub-show-all-events
Click the "My events" entry in the left sidebar
le-event-hub-show-my-events

Reset all filters in the event hub

le-event-hub-reset-filter
Click the "Duplicate event" entry in an event's context menu
le-event-duplicated
Start editing an event
le-event-edit-start
Display the event macro in a Confluence page
le-event-macro
Sign up for an event
le-event-self-signup
Sign off from an event
le-event-self-signoff
Display the event list macro in a Confluence page
le-event-list-macro
Display the detail view for an event
le-event-detail
Register a colleague for an event
le-event-signup-other
Set an Unsplash image for an event
le-stockimage-set
Upload an event image from your computer
le-image-uploaded
Save an event after editing it
le-event-saved
Search Unsplash for an event image
le-stock-image-search

Admin

Enable / Disable Unsplash integration for your Confluence instance

le-admin-unsplashConfiguration

Admin

Add a new event category

le-admin-eventCategory-created

Admin

Edit an existing event category

le-admin-eventCategory-updated

Admin

Delete an existing event category

le-admin-eventCategory-deleted
 Linchpin Intranet Suite

Event

Technical event name

when clicking on the info button to see the details of an entry on the Linchpin admin dashboard

admin-dashboard-item-details

when clicking on any link to reach a configuration page from the Linchpin admin dashboard

admin-dashboard-navigation

after a small waiting time while using the search on the Linchpin admin dashboard

admin-dashboard-search

when viewing the admin dashboard

admin-dashboard

viewing the setup assistant

admin-assistant-started

finishing the setup assistant and returning to the dashboard

admin-assistant-ended

skipping the setup assistant after starting it

admin-assistant-skipped

finishing the setup assistant with a selected primary color as value in hex code

admin-assistant-color

finishing the setup assistant with the selected dashboard type as value

admin-assistant-dashboard

finishing the setup assistant with or without demo content as value

admin-assistant-demodata

 Linchpin Launchpad

Event

Technical event name

viewing the global settings

settings

viewing the app label settings

app-labels-settings

viewing the category settings

category-settings

viewing the app management

app-management

viewing the suggested apps

suggested-apps

viewing the create app form

create-app

viewing the edit app form

edit-app

viewing the bulk edit form

bulk-edit

viewing the portal

portal

viewing all apps on the portal

portal-all-apps

viewing my apps on the portal

portal-my-apps

viewing recommended apps on the portal

portal-recommended

viewing new apps on the portal

portal-new-apps

viewing any category on the portal

portal-category

viewing the dialog to suggest an app on the portal

portal-suggest-dialog

viewing the help on the portal

portal-help

viewing a page with a page macro

apps-macro

viewing the app details dialog

app-details

saving settings with "mark as new" with the weeks of "off" as value

settings-mark-as-new

saving settings with personalization with "on" or "off" as value

settings-personalization

favoring an app

favor-app

unfavoring an app

unfavor-app

suggesting an app

suggest-app

creating an app

create-app

editing an app

edit-app

deleting an app

delete-app

bulk editing apps

bulk-edit

publishing a suggestion

publish-suggestion

deleting a suggestion

delete-suggestion

 Linchpin Translations
EventTechnical event name

viewing the editor in the global administration

global-editor

generating and installing a language pack from a project

install-jar

generating and downloading a language pack from a project

download-jar

viewing the upload dialog to import translations into a project

upload-dialog

uploading a jar or file to import translations into a project

upload-jar-or-file

saving a project in the global administration

project-save

starting to edit a project name

project-name-edit-start

adding a translations key

key-add

marking a column of a certain language for deletion in the global administration

translation-column-delete

marking a row of a certain translation key for deletion in the global administration

translation-row-delete

starting to edit a complete row of a certain translation in the global administration

translation-row-edit

viewing the modal to see all locales of a project

project-locales

starting to edit a translation key

key-edit-start

starting to edit a certain translation for a key and a language

translation-cell-edit-start

viewing the version history of a translation cell

translation-cell-versions

viewing the comments to a translation cell

translation-cell-comments

adding a comment to a translation cell

translation-cell-comment-save

resetting the comment editor

translation-cell-comment-reset

marking a translation cell for deletion

translation-cell-delete

viewing the complete history of a project

project-history

adding a locale to a project in global administration

locale-add

toggling the visibility of a language in global administration

locale-toggle-visibility

deleting a locale from a project in global administration

locale-delete

viewing the project creation modal dialog

project-create-dialog

creating a new project

project-create-submit

canceling the creation of a new project

project-create-cancel

viewing the translation dialog inside a Linchpin Plugin

plugin-translation-dialog

saving the translations made inside a Linchpin Plugin

plugin-translation-save

canceling or simply closing the translations dialog inside a Linchpin Plugin

plugin-translation-cancel

adding a locale to a translation inside a Linchpin Plugin

plugin-translation-add-local

editing a column of a certain language inside a Linchpin Plugin

plugin-translation-column-edit

marking a column of a certain language for deletion inside a Linchpin Plugin

plugin-translation-column-delete

starting to edit a translation cell inside a Linchpin Plugin

plugin-translation-cell-edit

 Linchpin User Profiles


EventTechnical event name
People directory: Directory is visited: loading duration of results

lup-peopledirectory-view

People directory: Directory is visited: number of result pages

lup-peopledirectory-view-available-pages

People directory: Search or filter is used: Length of search termlup-peopledirectory-search-search-term-length
People directory: Search or filter is used: Number of selected filterslup-peopledirectory-search-number-of-filters
People directory: Search or filter is used: Show only people with personal space?lup-peopledirectory-search-only-personal
People directory: Search or filter is used: number of result pageslup-peopledirectory-search-available-pages
People directory: Search or filter is used: current result page numberlup-peopledirectory-search-page-number
People directory: Search or filter is used: number of results on the current result pagelup-peopledirectory-search-results
People directory: Search or filter is used: loading duration of resultslup-peopledirectory-search-load-duration
People directory: "Reset filters" is used: loading duration of resultslup-peopledirectory-reset-filters-load-duration
Org charts: Configuration saved: number of configured root userslup-orgcharts-config-root-users
People directory: Org charts viewed: loading duration of configlup-orgcharts-portal-init
Org charts: Org chart viewed: loading duration of org chart

<MODE>: "portal" (People directory), "profile" or "macro"
lup-orgcharts-<MODE>-view
Org charts: Org chart viewed: selected depthlup-orgcharts-<MODE>-view-depth
Org charts: Org chart viewed: number of initially shown userslup-orgcharts-<MODE>-view-user-count
Org charts: Clicked "Reset"lup-orgcharts-<MODE>-reset
Org charts: Clicked "Center"lup-orgcharts-<MODE>-center
Org charts: Changed depth (only in modes "portal" and "macro"): new depthlup-orgcharts-<MODE>-set-depth
Org charts: Expanded <TYPE> of a user

<TYPE>: "parent" (superior), "children" (subordinates), "siblings" (other children of the parent)
lup-orgcharts-<MODE>-expand-<TYPE>
Org charts: Collapsed <TYPE> of a userlup-orgcharts-<MODE>-collapse-<TYPE>
 Microblogging for Confluence
EventTechnical event name

opening the editor for a new post

post-start

posting a new post with duration since opening in value

post-post-it

cancellation of a new post with duration since opening in value

post-cancel

opening the editor for a new reply

reply-start

posting a new reply with duration since opening in value

reply-post-it

cancellation of a new reply with duration since opening in value

reply-cancel

opening the editor to edit a post

post-edit-start

save of a post edit with duration since opening in value

post-edit-post-it

cancellation of a post edit with duration since opening in value

post-edit-cancel

opening the editor to edit a reply

reply-edit-start

save of a reply edit with duration since opening in value

reply-edit-post-it

cancellation of a reply edit with duration since opening in value

reply-edit-cancel

deleting a post

post-delete

deleting a reply

reply-delete

viewing a warning when navigating while unsaved content is in the editor

show-editor-close-confirmation

viewing the portal

portal

viewing a single post

single-post

viewing a page with the timeline macro

page-with-macro

viewing the general administration

admin-general

viewing the global topic administration

admin-topics

viewing the permission administration

admin-permissions

viewing the topic administration within space tools

spaceadmin-topics

saved configuration value for the post max height to collapse content in value

globalconfig-max-post-height

saved configuration to allow post deletions in value

globalconfig-allow-post-delete

saved permission to write posts in value

globalconfig-permission

saving a new topic in global topic administration

admin-topic-create-submit

cancellation of a new topic in global topic administration

admin-topic-create-cancel

editing a topic in global topic administration

admin-topic-edit

saving a topic edit in global topic administration

admin-topic-edit-submit

cancellation of a topic edit in global topic administration

admin-topic-edit-cancel

moving a topic in global topic administration

admin-topic-move

deleting a topic in global topic administration with decision what happens to posts in value

admin-topic-delete

saving a new topic in topic administration within space tools

spaceadmin-topic-create-submit

cancellation of a new topic in topic administration within space tools

spaceadmin-topic-create-cancel

editing a topic in topic administration within space tools

spaceadmin-topic-edit

saving a topic edit in topic administration within space tools

spaceadmin-topic-edit-submit

cancellation of a topic edit in topic administration within space tools

spaceadmin-topic-edit-cancel

moving a topic in topic administration within space tools

spaceadmin-topic-move

deleting a topic in topic administration within space tools with decision what happens to posts in value

spaceadmin-topic-delete

viewing a message i.e. an error or an empty state, the kind is determined by the value

timeline-message

inserting or editing the timeline macro with the macrobrowser

timeline-macro-insert

inserting or editing the timeline template macro with the macrobrowser

timeline-template-macro-insert

configured macro param to show sidebar in value

timeline-macro-config-sidebar

configured macro param with the initially maximum number of visible replies in value

timeline-macro-config-reply-limit

configured macro param what kind of timeline to show in value (global, space, topic)

timeline-macro-config-source

configured macro param the maximum number of posts in the timeline in value

timeline-macro-config-limit

 Terms of Use

Event

Technical event name

viewing the global configuration of disclaimers

global-configuration

viewing the history of agreements for all users

user-history

viewing the history in your own user profile

user-profile

viewing the disclaimer which has to be agreed or denied with the mode (just view it or blocked to agree) as value

disclaimer

viewing a disclaimer of a user in the history for all users

disclaimer-in-history

saving a disclaimer with the selected content mode WYSIWYG or FULL_CUSTOMIZED as value

save-disclaimer

saving translations for the disclaimer with the number of different locales as value

save-translation

saving a default locale for the disclaimer with the default as value

save-default-locale

saving revocation recipients

save-revocation-recipients

saving revocation recipients with number of users as value

save-revocation-recipients

saving revocation recipients with number of groups as value

save-revocation-recipients

searching for specific users in the agreement history

search-user

filtering by an agreement status in the history

search-status

expanding the history of a user

expand-user-history

collapsing the history of a user

collapse-user-history

downloading a disclaimer as PDF

download-pdf