The page.display
event occurs when a user accesses a page. It occurs on both the web application side and the server side.
This event contains the following fields:
Field | Description |
---|---|
page |
An object containing information about the displayed page. |
id |
The page's identifier. |
language |
The language defined for the page if it is a designed page. |
name |
The page's name. |
type |
The page's type. Can be DESIGNED_HOME_PAGE , DESIGNED_PAGE , DESIGNED_READER_PAGE , HOME_PAGE , READER_PAGE , SEARCH_PAGE , VIEWER_PAGE , or ANALYTICS_PAGE . |
url |
The URL path used to access the page. |
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. |
display |
Contains the following information about the user's display: |
width |
The display's width in pixels. |
height |
The display's height in pixels. |
A table for the most common fields is in Analytics events.
Listening to the page.display
event
When listening to the page.display
event, it is only possible to retrieve the information that the web application sends. The web application sends information about the following page types:
HOME_PAGE
READER_PAGE
SEARCH_PAGE
VIEWER_PAGE
Since designed pages and analytics pages are only available on the server side, they are not available when listening to the page.display
event.
Example:
[
{
"appName": "ft/turnkey-portal",
"appVersion": "4.2.26",
"contentLocale": "en-US",
"datetime": 1704095208217,
"id": "f710c178-92d0-4622-81bc-ed10256c6fdd",
"name": "page.display",
"offline": false,
"parameters": {
"display": {
"width": 1324,
"height": 738
},
"origin": {
"type": "unknown",
"url": "",
"pageType": "unknown"
},
"page": {
"id": "ft/home",
"type": "homePage",
"url": "/",
"name": "home"
}
},
"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"
}
]