This server event occurs when a FEEDBACK_USER user rates a topic.
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. |
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). |
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. |
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.
Example:
[
{
"breadcrumb": [
{
"tocId": "1eEwEhsoi3ZjjOITB0j1sw",
"title": "Knowledge Hub web services for everyone"
},
{
"tocId": "bSKKl6POa3degGf~qpseXA",
"title": "Section"
},
{
"tocId": "LbzMHLNP7uJRcGa9Po~4bA",
"title": "Get the content of an HTML section"
}
],
"document": {
"id": "Eb9T08h5UbpP~FAvJ84DHQ",
"title": "Fluid Topics API Reference Guide",
"type": "STRUCTURED_DOCUMENT",
"metadata": []
},
"rating": {
"type": "like",
"value": "1"
}
}
]