This web application event occurs when any user selects the Share URL action button of a book, topic or unstructured document.
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 metadata with the label and values of each key. |
title |
The title of the document. |
type |
The document's type (for example STRUCTURED_DOCUMENT). |
mimeType |
The document's MIME type for an UNSTRUCTURED_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. |
The link.share event also occurs when a user shares a document's URL. However, the breadcrumb is empty in this case.
A table for the most common fields is in Analytics events.
Example:
[
{
"appName": "ft/turnkey-portal",
"appVersion": "4.2.11",
"contentLocale": "en-US",
"datetime": 1696423590677,
"id": "20afc11d-ec58-4e2c-aad8-d0e4e06eb6b8",
"name": "link.share",
"offline": false,
"parameters": {
"breadcrumb": [
{
"tocId": "U3W7e7i2FsS9ivAMBKaWjQ",
"title": "Authentication"
},
{
"tocId": "7c9QxYnEhetURNt9dVu1ig",
"title": "Fluid Topics User Password Recovery"
}
],
"document": {
"id": "16QJjK5U6wIMB4shtxbRrg",
"title": "Fluid Topics User Guide",
"type": "STRUCTURED_DOCUMENT",
"metadata": [
{
"key": "Product",
"label": "Product",
"values": [
"Fluid Topics"
]
},
{
"key": "Version_FT",
"label": "Fluid Topics Version",
"values": [
"Latest"
]
},
{
"key": "Category",
"label": "Category",
"values": [
"Reference Guides"
]
},
{
"key": "language",
"label": "Language",
"values": [
"English"
]
},
{
"key": "audience",
"label": "Target Audience",
"values": [
"public"
]
}
]
}
},
"sessionId": "a82e1a66-8c35-4252-9143-4da0ec8ef333",
"tenantId": "1-stable",
"uiLocale": "en-US",
"user": {
"groups": [
"ft:administrator",
"ft:authenticated"
],
"id": "d554325-eef7-4850-93c1-cea73446582060",
"roles": [
"PDF_EXPORT_USER",
"HTML_EXPORT_USER",
"COLLECTION_USER",
"PRINT_USER",
"PERSONAL_BOOK_SHARE_USER",
"RATING_USER",
"FEEDBACK_USER",
"SAVED_SEARCH_USER",
"PERSONAL_BOOK_USER",
"OFFLINE_USER",
"ADMIN"
]
},
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
"userIp": "192.168.21.3"
}
]