This web application event occurs when a topic stops being displayed on the web app or when the user is inactive for 28 minutes.
Depending on the user's Operating System and browser, the web application might not send this event when the user closes it.
This event contains the following fields:
| Field | Description |
|---|---|
breadcrumb |
Contains the list of topics leading to this topic in the document's table of contents. Each topic contains its tocId and title. |
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. |
location |
An object indicating where and how the document appeared. |
type |
Can be page when the document appears on the entire page, or preview when only a part of the document appears. |
value |
Contains more information about where the document appeared. For example, when the type is page, the value can be reader, meaning that the document was displayed in the Reader page. |
viewDurationMs |
Contains the length of time the topic was displayed in milliseconds. |
A table for the most common fields is in Analytics events.
Example:
[
{
"breadcrumb": [
{
"tocId": "MnQI73gUPmcBJdraxWMvtQ",
"title": "Build Filters"
},
{
"tocId": "7taiPEGZJ80z5QJwDptiOw",
"title": "afs_rte_build"
}
],
"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": "designed-reader"
},
"viewDurationMs": 174
}
]