This event occurs when a user sends feedback about one of the following types of content:
- A topic in a structured document.
- A structured document.
- An 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 mimeType 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 . |
loggedIn |
true if the user is authenticated. |
A table for the most common fields is in Analytics events.
Example:
[
{
"name": "feedback.send",
"appName": "ft/turnkey-portal",
"appVersion": "3.11.13",
"offline": false,
"contentLocale": "en-US",
"uiLocale": "en-US",
"parameters": {
"document": {
"id": "x_UrzBm1ZjrB2_u7uXkECw",
"title": "Install Fluid Topics on Multiple Servers",
"type": "STRUCTURED_DOCUMENT",
"metadata": [
{
"key": "Version_FT",
"label": "Version",
"values": [
"3.6"
]
},
{
"key": "Platform",
"label": "Operating System",
"values": [
"RHEL"
]
},
{
"key": "Category",
"label": "Category",
"values": [
"Technical Notes"
]
},
{
"key": "audience",
"label": "Audience",
"values": [
"public"
]
}
],
"mimeType": null,
"parentId": null
},
"breadcrumb": [
{
"tocId": "a993DAVQSIh2zMSm7ShhoA",
"title": "Multiple-Server Installation"
}
],
"loggedIn": true
}
}
]