document.display - Fluid Topics - Latest

Integrate the Fluid Topics API
Category
Technical Notes
Audience
public
Version
Latest

This web application event occurs when a document stops being displayed in the web app or when the user is inactive for 28 minutes.

  • The document.display event is deprecated. It is unmaintained. The document.start_display event replaces it.
  • 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
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).
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 document was displayed in milliseconds.

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

Example:

[
  {
    "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"
    },
    "viewDurationMs": 2840
  }
]