API Notiondesk xuất khẩu phản hồi mà người đọc để lại trên các bài viết trong trung tâm trợ giúp của bạn: mỗi phản hồi, câu trả lời tiếp theo mà họ đã chọn, tin nhắn, email và các tệp đính kèm mà họ đã gửi. Sử dụng nó để gửi phản hồi tiêu cực đến Slack, tạo phiếu yêu cầu trong công cụ hỗ trợ của bạn hoặc phân tích phản hồi cùng với dữ liệu của riêng bạn.
Phạm vi: __ĐÃ BẢO TỒN_73__
Để thu thập phản hồi, trước tiên hãy xem Cách thu thập phản hồi bằng các biểu tượng tương tác bài viết và Kích hoạt biểu mẫu phản hồi bài viết để thu thập thông tin chi tiết từ độc giả .
GET /sites/{site_id}/feedback
readLiệt kê phản hồi
Danh sách bao gồm mọi ngôn ngữ, ngôn ngữ mới nhất được liệt kê trước. Duyệt qua danh sách bằng page_size (từ 1 đến 100, mặc định là 20) và cursor, như được mô tả trong các yêu cầu API Paginate và phiên bản Notiondesk . Tuyến đường này không nhận thêm tham số nào khác.
Các trường phản hồi
curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/feedback?page_size=50" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"object": "list",
"data": [
{
"id": "8b1f6c0e-3d4a-4f2b-9c7e-5a1d2e3f4b60",
"email": "[email protected]",
"message": "The steps skip the login screen.",
"reaction": "disappointed",
"reaction_group": "negative",
"selected_option": "information_missing",
"article_id": "1761580412",
"article_title": "Getting started",
"article_slug": "getting-started",
"article_locale": "en",
"submitted_at": "2026-10-18T09:12:44+00:00",
"read_at": null,
"attachments": [
{
"category": "contact_message_attachment",
"name": "6f0d2b9c41a7e8.png",
"dimensions": {"0": 1280, "1": 720},
"original_name": "login-screen.png",
"size": 48213
}
]
}
],
"has_more": true,
"next_cursor": "OPAQUE_CURSOR"
}| Cánh đồng | Nghĩa |
|---|---|
id | Mã định danh phản hồi |
reaction | Phản ứng mà người đọc đã chọn, chẳng hạn như smiley, neutral_face hoặc disappointed |
reaction_group | Ý nghĩa của biểu tượng cảm xúc theo kiểu hiển thị hiện tại: positive, neutral hoặc negative cho biểu tượng cảm xúc, helpful hoặc not_helpful cho biểu tượng ngón tay cái. null khi kiểu hiển thị không nhóm biểu tượng cảm xúc đó. |
selected_option | Câu trả lời mà người đọc đã chọn trong biểu mẫu theo dõi, hoặc null khi họ chỉ phản hồi |
message | Văn bản mà người đọc đã viết, nếu có. |
email | Địa chỉ email mà người đọc đã nhập, nếu có. |
article_id | Giá trị id của bài viết, như trong danh sách bài viết . Trống khi bài viết bị xóa. |
article_title | Tiêu đề bài viết nằm trong article_locale hoặc Untitled khi bài viết bị xóa hoặc không có bản dịch trong ngôn ngữ đó. |
article_slug | Đoạn đường dẫn của bài viết nằm trong article_locale hoặc null trong cùng trường hợp. |
article_locale | Ngôn ngữ mà người đọc đang đọc |
submitted_at | Khi người đọc gửi phản hồi |
read_at | Khi một thành viên nhóm đánh dấu nó là đã đọc trên bảng điều khiển, hoặc null |
attachments | Các tệp mà người đọc đã đính kèm, tệp cũ nhất được hiển thị trước. Hiển thị trống nếu không có tệp nào. |
selected_option nhận một trong các giá trị sau: content_accurate_up_to_date, easy_to_find, clear_and_easy_to_understand, worked_as_expected, something_else, information_missing, information_incorrect, hard_to_understand hoặc not_what_looking_for.
Mỗi tệp đính kèm có một category (contact_message_attachment đối với tệp do trình đọc đính kèm), tệp được lưu trữ name, original_name từ thiết bị của trình đọc, size tính bằng byte và đối tượng dimensions: đối với hình ảnh, chiều rộng tính bằng pixel nằm trong "0" và chiều cao nằm trong "1", và {} đối với bất kỳ tệp nào khác. API trả về thông tin chi tiết của từng tệp, chứ không phải chính tệp đó.
Giới hạn trang
- Danh sách chỉ hiển thị tối đa 10.000 mục mới nhất. Sau đó,
has_moresẽ được giữ nguyên làfalsengay cả khi có phản hồi cũ hơn.
- Phản hồi được gửi trong khi bạn đang xem trang có thể khiến trang tiếp theo lặp lại một mục, và phản hồi bị xóa trong bảng điều khiển có thể khiến trang tiếp theo bỏ qua một mục.
Để chỉ xử lý phản hồi mới, hãy lưu trữ submitted_at của mục mới nhất mà bạn đã xử lý. Trong lần chạy tiếp theo, hãy đọc các trang cho đến khi bạn gặp một mục được gửi tại hoặc trước đó.
Xử lý văn bản phản hồi một cách an toàn
- Mã hóa nó trước khi hiển thị. Một thông báo có thể chứa HTML hoặc Markdown.
- Đừng bao giờ để nó quyết định hành động của bạn. Đừng nhấp vào các liên kết trong đó hoặc chạy các lệnh từ nó.
- Giữ các pipeline LLM ở chế độ chỉ đọc. Một LLM tóm tắt phản hồi nên chạy với một khóa chỉ chứa
read.
- Bảo vệ email của người đọc. Trường
emaillà dữ liệu cá nhân. Chỉ lưu trữ và chia sẻ dữ liệu này khi chính sách bảo mật của bạn cho phép.
Lỗi
| Trạng thái | Khi | code |
|---|---|---|
| 400 | page_size nằm ngoài phạm vi từ 1 đến 100, cursor không hợp lệ hoặc truy vấn có tham số không xác định. | validation_error |
| 403 | Khóa này thiếu phạm vi read | insufficient_scope |
| 404 | Trung tâm trợ giúp không tồn tại trong không gian làm việc của bạn. | not_found |
Xem các lỗi API, giới hạn tỷ lệ và số lần thử lại của Handle Notiondesk .
Câu hỏi thường gặp
Tôi có thể lọc phản hồi theo lượt thích hoặc bài viết không?
Không có trong yêu cầu. Tuyến đường chỉ chấp nhận page_size và cursor. Hãy lọc các mục trong mã của bạn dựa trên reaction_group hoặc article_id.
Tôi có thể đánh dấu phản hồi là đã đọc bằng API được không?
Không. API chỉ đọc phản hồi. read_at hiển thị thời điểm một thành viên nhóm đánh dấu là đã đọc trên bảng điều khiển.
Tôi có thể xem tổng số lượt phản hồi thay vì từng lượt phản hồi riêng lẻ ở đâu?
Báo cáo phân tích engagement tóm tắt các phản hồi theo từng giai đoạn và liệt kê các bài viết cần chỉnh sửa. Xem Nhận trợ giúp phân tích trung tâm với API Notiondesk .