This server event occurs when a FEEDBACK_USER user rates a 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. |
rating |
An object containing information about the rating. |
type |
The type of rating (for example, like, stars, or dichotomous). |
value |
The value of the rating (for example, 1 for like, 0 for dislike). |
Since this event originates from the server and not the web application, it is not possible to listen to it.
A table for the most common fields is in Analytics events.
[
{
"document": {
"id": "m27nLjomVg08FbI7W1Mvjg",
"title": "Author-it Connector Reference 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": [
"Technical Notes"
]
},
{
"key": "audience",
"label": "Target Audience",
"values": [
"public"
]
}
]
},
"rating": {
"type": "stars",
"value": "1"
}
}
]