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 |
|---|---|
breadcrumb |
Contains the list of topics leading to this topic in the document's table of contents. Each topic contains its tocId and title. |
document |
An object containing information about the document. |
id |
The document's identifier. |
title |
The title of the document. |
type |
The document's type (for example STRUCTURED_DOCUMENT). |
metadata |
A list of the document's metadata with the label and values of each key. |
mimeType |
The document's MIME type for an UNSTRUCTURED_DOCUMENT. |
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:
[
{
"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"
]
}
]
}
}
]