Summary
This solution tracks user interactions with certain OOTB and LiveTiles developed components from the intranet
Prerequisites
As prerequisites, LiveTiles analytics has the following:
- a Microsoft 365 tenant
- LiveTiles Analytics application customizer
- LiveTiles Operation Center must be set up. The guide on accomplishing this can be found here.
Features
Activity tracking
The LiveTiles Analytics solution tracks user activity like page visits and interactions with certain OOTB SharePoint components, as well as components developed by LiveTiles such as the LiveTiles MegaMenu and the Everywhere Panel.
A complete list of the components monitored for activities by this solution:
- LiveTiles MegaMenu
- LiveTiles Everywhere Panel
- Legacy version of the LiveTiles Intranet MegaMenu (Matrix navigation included)
- IXP Quicklinks
- SharePoint horizontal and vertical navigation
- SharePoint app bar
Activities tracked on each monitored component:
- LiveTiles MegaMenu
- clicks on nodes
- LiveTiles Everywhere Panel
- opening a tab from the Everywhere Panel
- Legacy version of the LiveTiles Intranet MegaMenu (Matrix navigation included)
- clicking a link from the navigation menu
- navigation via matrix navigation
- IXP Quicklinks
- clicking a link
- SharePoint horizontal and vertical navigation
- clicking a link
- SharePoint app bar
- opening a tab from the app bar
Organization information
The LiveTiles Analytics solution also makes use of the tenant ID as well as the display name of the organization to include it in the tracked data. This information is retrieved by querying the Microsoft Graph API.
Besides this, the solution will also need to query the LiveTiles Frontoffice API to retrieve the region code that the tenant was associated with while setting up the Operation Center. This allows us to separate user data by region.
As an example, data from a customer that is based in Europe will be stored in our data center from Europe, while data from a customer located in the United States will be sent to our data center that is assigned to the Americas.
User information
This solution tracks user activity, and aggregates it with surface-level user information such as department, job title, etc.
The user-specific information is retrieved from their MS Entra ID user profiles through the MS Graph API. A complete list of the Entra ID user profile properties that LiveTiles Analytics uses is:
- user ID
- user principal name
- user department
- preferred language
- job title
- company name
- department
- country
The solution requires the User.Read delegated permissions to read the current user's profile properties.
Other tracked data
Besides user profile and organization information, LiveTiles Analytics also uses information about the browser, device, operating system, session and screen size.
Cached information
After the user profile information is retrieved from the MS Entra ID, it will be cached for 24 hours. After being retrieved from the LiveTiles Frontoffice API and the MS Graph API, the regional code, as well as the organization name are going to be cached without an expiration time limit.
Raw data format
A typical activity tracked by the Analytics module will have this structure:
{
"timestamp": "2023-12-11T14:39:34.845Z",
"event": "interaction",
"type": "track",
"properties": { ... },
"context": {
"page": {
"path": "/sites/test_site",
"referrer": "",
"search": "",
"title": "test_site - Home",
"url": "https://contoso.sharepoint.com/sites/test_site"
},
"app": {
"name": "sharepoint"
},
"browser": {
"name": "chrome",
"version": "119.0.0"
},
"device": {
"model": "Windows NT 10.0",
"platform": "web"
},
"os": {
"name": "windows",
"version": "Windows NT 10.0; Win64; x64"
},
"screen": {
"density": 1,
"height": 963,
"width": 1920
},
"session": {
"sessionId": "00000000-0000-0000-0000-000000000000",
"pageSessionId": "00000000-0000-0000-0000-000000000000"
},
"workspace": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Contoso",
"region": "emea"
},
"user": {
"id": "00000000-0000-0000-0000-000000000000",
"companyName": "Company name",
"country": "United Kingdom",
"department": "Engineering",
"preferredLanguage": "en-US",
"jobTitle": "Architect",
"userPrincipalName": "user@domain.onmicrosoft.com"
}
}
Comments
0 comments
Please sign in to leave a comment.