page.display - Fluid Topics - Latest

Integrate the Fluid Topics API

Category
Technical Notes
Audience
public
Version
Latest

This web application event occurs when any user accesses a page.

This event contains the following fields:

Field Description
display Contains the following information about the user's display:
width The display's width in pixels.
height The display's height in pixels.
origin Contains the following information about the user's point of origin:
type The type of origin. Can be INTERNAL, EXTERNAL, or UNKNOWN.
url The origin's host (referrer) or token.
pageType The origin page's type. It can be the page token for internal access or UNKNOWN for others accesses.
page An object containing information about the displayed page.
id The page's identifier.
type The page's type. Can be DESIGNED_HOME_PAGE, CUSTOM_PAGE, DESIGNED_READER_PAGE, DESIGNED_SEARCH_PAGE, HOME_PAGE, READER_PAGE, SEARCH_PAGE, VIEWER_PAGE, or ANALYTICS_PAGE.
url The URL path used to access the page.
name The page's name.
language The language defined for the page if it is a designed page.

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

Listening to the page.display event

The page.display event is a web application event. It is possible to listen to it. However, visiting the Administration, Analytics, My Library or My Account menus does not trigger the event.

Example:

[
    {
        "display": {
            "width": 1324,
            "height": 738
        },
        "origin": {
            "type": "unknown",
            "url": "",
            "pageType": "unknown"
        },
        "page": {
            "id": "ft/home",
            "type": "homePage",
            "url": "/",
            "name": "home"
        }
    }
]