This server event occurs when a user selects the Download button in the portal to download an unstructured document or an attachment.
Loading or saving an unstructured document or an attachment in a browser's PDF viewer does not trigger a document.download event.
This event contains the following fields:
| Field | Description |
|---|---|
document |
An object containing information about the downloaded document or attachment. |
id |
The ID of the downloaded document or attachment. |
title |
The title of the downloaded document or attachment. |
metadata |
A list of metadata with the label and values of each key. |
type |
The type of the downloaded content (for example, UNSTRUCTURED_DOCUMENT). |
mimeType |
The format of the downloaded document or attachment. |
parentId |
The ID of the parent publication when the downloaded document is an attachment. |
location |
Indicates where and how the document or attachment was downloaded. |
type |
Can be page when the document is downloaded from a page. |
value |
Contains more information about where the document appeared. For example, when the type is page, the value can be viewer, meaning that the document was displayed in the Viewer page. |
A table for the most common fields is in Analytics events.
Example:
[
{
"document": {
"id": "~P4PYSpVD1CkBb7HvqnbHQ",
"title": "download.jpeg",
"type": "ATTACHMENT",
"metadata": [],
"mimeType": "image/jpeg",
"parentId": "oM6Iz2NNbQr26hw6mcfrGA"
},
"location": {
"type": "page",
"value": "reader"
}
}
]