This web application event occurs when a user selects the Download button in the portal to download an unstructured document or a map attachment.
Loading or saving an unstructured document or a map 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 map attachment. |
id |
The ID of the downloaded document or map attachment. |
metadata |
A list of metadata with the label and values of each key. |
mimeType |
The format of the downloaded document or map attachment. |
title |
The title of the downloaded document or map attachment. |
type |
The type of the downloaded content (for example, UNSTRUCTURED_DOCUMENT ). |
location |
Indicates where and how the document or map attachment was downloaded with the following fields: |
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": "design-export-examples.zip",
"type": "MAP_ATTACHMENT",
"metadata": [],
"mimeType": "application/zip"
},
"location": {
"type": "page",
"value": "reader"
}
}
]