Feedback
The Feedback API gives users a way to send feedback on how useful the responses were.
Important
The Feedback covered by this API conveys how relevant specific answers have been in response to the search questions. This kind of information is not available for browsing articles based on categories.
Authorization
The operations carried out by the Feedback API can be accessed by all roles.
No Answer
| Description
|
Marks a query as not having a valid answer in the knowledge base
|
| URL
|
/feedback/{kbId}/noAnswer
|
| Method
|
POST
|
| Request Content-Type
|
—
|
| Response Content-Type
|
application/json
|
| Role
|
Any
|
| URL IDs
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
|
| URL parameters
|
| Parameter
|
Type
|
Required
|
Default
|
Description
|
| lang
|
String
|
Yes
|
"_default"
|
Language ID
|
| sessionId
|
String
|
No
|
—
|
Session ID
|
|
| Request
|
Search query, as described in "Search for answers" in the FAQ Retrieval API section
| Parameter
|
Type
|
Required
|
Default
|
Description
|
| query
|
String
|
Yes
|
|
User query
|
| categories
|
String[]
|
No
|
|
Related categories
|
|
| Response
|
Empty
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
Register Vote
| Description
|
Records the user rating for the document within the query
|
| URL
|
/feedback/{kbId}/documents/{docId}/vote
|
| Method
|
POST
|
| Request Content-Type
|
—
|
| Response Content-Type
|
application/json
|
| Role
|
Any
|
| URL IDs
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
| {docId}
|
String
|
Document ID
|
|
| URL Parameters
|
| Parameter
|
Type
|
Required
|
Default
|
Description
|
| relevant
|
Boolean
|
No
|
true
|
Was the search result relevant?
|
| lang
|
String
|
No
|
"_default"
|
Language ID
|
| sessionId
|
String
|
No
|
—
|
Unique session ID
|
|
| Request
|
SearchRequest
|
| Response
|
Empty
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
Register Vote for Query Results
| Description
|
Tallies request.likeDocId as a positive vote, as well as all of the documents from request.selection, excluding request.likeDocId as negative in relation to the request.
|
| URL
|
/feedback/{kbId}/documents/{docId}/advancevote
|
| Method
|
POST
|
| Request Content-Type
|
—
|
| Response Content-Type
|
application/json
|
| Role
|
Any
|
| URL IDs
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
| {docId}
|
String
|
Document ID
|
|
| URL Parameters
|
| Parameter
|
Type
|
Required
|
Default
|
Description
|
| lang
|
String
|
No
|
"_default"
|
Language ID
|
| sessionId
|
String
|
No
|
—
|
Unique session ID
|
|
| Request
|
AdvanceVote
| Field
|
Type
|
Required
|
Description
|
| likeDocId
|
String
|
Yes
|
ID of document for which a positive vote is being registered
|
| selection
|
String []
|
No
|
ID ranges of documents for which a negative vote is being registered. Includes all IDs in the selection, including those documents for which a positive vote is being registered.
|
| request
|
SearchRequest
|
Yes
|
Original search request.
|
|
| Response
|
Empty
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
Register Visit
| Description
|
Increments the counter of the viewed document
|
| URL
|
/feedback/{kbId}/documents/{docid}/visit
|
| Method
|
POST
|
| Request Content-Type
|
—
|
| Response Content-Type
|
application/json
|
| Role
|
Any
|
| URL IDs
|
| Parameter
|
Type
|
Description
|
| {kbId}
|
String
|
Knowledge base ID
|
| {docId}
|
String
|
Unique document ID
|
|
| URL parameters
|
| Parameter
|
Type
|
Required
|
Default
|
Description
|
| lang
|
String
|
No
|
"_default"
|
Language
|
| sessionId
|
String
|
No
|
—
|
Unique session ID for history tracking
|
|
| Request
|
SearchRequest
|
| Response
|
|
| Notes
|
If successful, 200 OK is returned. However, if the dataset already exists, 400 BAD REQUEST is returned.
|
