topic.display - Fluid Topics

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, this event might not be sent when the user closes the app.

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.
`metadata`	A list of the document's displayed metadata with the label and values of each key.
`title`	The title of the document.
`type`	The document's type (for example, `STRUCTURED_DOCUMENT`).
`breadcrumb`	Contains the list of topics leading to this topic in the document's table of contents. Each topic contains its `tocId` and `title`.
`viewDurationMs`	Contains the length of time the topic was displayed in milliseconds.

A table for the most common fields is in Analytics events.

Example:

[
   {
        "appName": "ft/turnkey-portal",
        "appVersion": "4.2.26",
        "contentLocale": "en-US",
        "datetime": 1704095218295,
        "id": "1aaba921-db24-4761-9d36-8a6a13fb8046",
        "name": "topic.display",
        "offline": false,
        "parameters": {
            "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
        },
        "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"
    }
]

topic.display - Fluid Topics - Latest

Integrate the Fluid Topics API