The most common fields for the analytics events are:
| Field | Description |
|---|---|
analyticsSessionId |
The unique identifier for the analytics session the event belongs to. |
appName |
The name of the application generating the event. |
appVersion |
The version of the application generating the event. |
contentLocale |
The content language chosen by the user. |
name |
The name of the event. |
offline |
Indicates whether the user generated the event while offline. |
parameters |
Defines the specific fields of the event, which are different for each event. See the following topics for details. |
sessionId |
The unique identifier for the session the event belongs to. |
tenantId |
The unique identifier for the tenant on which the event took place. |
datetime |
The timestamp of the event in milliseconds. |
uiLocale |
The interface language chosen by the user. |
userAgent |
The user agent found in the request generating the event. |
userGroups |
The groups the user belongs to. |
userId |
The unique identifier for the user generating the event. |
userIp |
The IP address of the user. |
userRoles |
The roles the user has. |
userRealm |
The realm through which the user logged in. It is empty if the user is not logged in. |
id |
The unique identifier for the event. |
version |
The version of the event. |
bot |
Whether a bot user triggered the event or not. |
Below is an example of an event with all its common fields:
{
"analyticsSessionId": "a21c3208-c88c-4e0a-bc80-eca2b542d88b",
"appName": "ft/turnkey-portal",
"appVersion": "5.1.65",
"contentLocale": "en-US",
"internal": false,
"name": "document.search",
"offline": false,
"structuredParameters": {
"document": {
"id": "ANb_3PaOpaJRo7MsMtabGQ",
"title": "Aurora 64B/66B LogiCORE IP Product Guide (PG074)",
"type": "STRUCTURED_DOCUMENT",
"metadata": [
{
"key": "Document_ID",
"label": "Document ID",
"values": [
"PG074"
]
},
{
"key": "Release_Date",
"label": "Release Date",
"values": [
"2024-12-11"
]
},
{
"key": "Doc_Version",
"label": "Version",
"values": [
"13.0 English"
]
},
{
"key": "ft:lastEdition",
"label": "ft:lastEdition",
"values": [
"2024-12-11"
]
}
]
},
"searchQuery": {
"terms": "loop"
},
"searchResponse": {
"nbResults": 3.0
}
},
"sessionId": "8671375f-a16f-4e69-b88c-2e9af4ae3528",
"tenantId": "70198-stable",
"datetime": 1761033221250,
"uiLocale": "en-US",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:144.0) Gecko/20100101 Firefox/144.0",
"userGroups": [],
"userId": "",
"userIp": "88.72.200.166",
"userRoles": [
"FEEDBACK_USER",
"PRINT_USER",
"RATING_USER"
],
"userRealm": "",
"id": "f698c867-3902-48a8-95c7-b3b7fbd6f681",
"version": "v0.1",
"bot": false
}