This web application event occurs when the web application starts displaying a publication, personal book, shared personal book, or map attachment.
This event contains the following fields:
| Field | Description |
|---|---|
location |
An object indicating where and how the document was displayed. |
type |
Can be page when the document is displayed in the entire page, or preview when only a part of the document was displayed. |
value |
Contains more information about where the document was displayed. For example, when the type is page, the value can be reader, meaning that the document was displayed in the Reader page. |
document |
An object containing information about the document. |
id |
The document's identifier. |
title |
The title of the document. |
type |
The document's type (for example, STRUCTURED_DOCUMENT). |
metadata |
A list of the document's displayed metadata with the label and values of each key. |
mimeType |
The document's MIME type for UNSTRUCTURED_DOCUMENT. |
A table for the most common fields is in Analytics events.
Example:
[
{
"appName": "ft/turnkey-portal",
"appVersion": "4.2.26",
"contentLocale": "en-US",
"datetime": 1704095218889,
"id": "1a3d540a-1ab9-4f46-834c-f5208846b282",
"name": "document.start_display",
"offline": false,
"parameters": {
"document": {
"id": "MUTHQr7DBstGQbqa1sJGhw",
"title": "AFS Filters Description",
"type": "STRUCTURED_DOCUMENT",
"metadata": [
{
"key": "Product",
"label": "Product",
"values": [
"AFS"
]
},
{
"key": "AFS_Version",
"label": "Plateforme",
"values": [
"7.14"
]
},
{
"key": "Category",
"label": "Category",
"values": [
"Reference Guides"
]
},
{
"key": "language",
"label": "Language",
"values": [
"English"
]
}
]
},
"location": {
"type": "page",
"value": "reader"
}
},
"sessionId": "0eec27b8-a943-4ffe-864e-74162630d234",
"tenantId": "1-stable",
"uiLocale": "fr-FR",
"user": {
"groups": [],
"id": "d554325-eef7-4850-93c1-cea73446582060",
"roles": [
"PRINT_USER",
"RATING_USER",
"FEEDBACK_USER"
]
},
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2.1 Safari/605.1.15",
"userIp": "192.168.2.3"
}
]