ממשק ה-API Notiondesk מייצא את המשוב שקוראים משאירים על מאמרי מרכז העזרה שלכם: כל תגובה, תשובת המעקב שבחרו, ההודעה שלהם, האימייל שלהם והקבצים שצירפו. השתמשו בו כדי לשלוח משוב שלילי ל-Slack, ליצור פניות בכלי התמיכה שלכם, או לנתח משוב לצד הנתונים שלכם.
היקף: read
כדי לאסוף משוב מלכתחילה, ראו כיצד לאסוף משוב באמצעות תגובות למאמרים והפעלת טופס משוב למאמרים כדי לאסוף תובנות קוראים .
GET /sites/{site_id}/feedback
readרשימת משוב
הרשימה מכסה כל שפה, החדשה ביותר תחילה. דפדפו בה עם page_size (1 עד 100, ברירת מחדל 20) ו-cursor, כמתואר ב- Paginate ו-version Notiondesk בקשות API . הנתיב אינו מקבל פרמטרים נוספים.
שדות משוב
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"
}| שָׂדֶה | מַשְׁמָעוּת |
|---|---|
id | מזהה המשוב |
reaction | התגובה שהקורא בחר, כגון smiley, neutral_face או disappointed |
reaction_group | מה המשמעות של התגובה תחת סגנון התגובה הנוכחי שלך: positive, neutral או negative עבור אימוג'י, helpful או not_helpful עבור תמונות אגודל. null כאשר הסגנון אינו מקבץ את התגובה הזו. |
selected_option | התשובה שהקורא בחר בטופס המעקב, או null כאשר הוא הגיב רק |
message | הטקסט שכתב הקורא, אם בכלל |
email | כתובת הדוא"ל שהקורא הזין, אם קיימת |
article_id | ה-id של המאמר, כמו ברשימת המאמרים . ריק כאשר המאמר נמחק. |
article_title | כותרת המאמר ב-article_locale, או Untitled כאשר המאמר נמחק או שאין לו תרגום בשפה זו. |
article_slug | קטע הנתיב של המאמר ב-article_locale, או null באותם מקרים |
article_locale | השפה שהקורא קרא |
submitted_at | כאשר הקורא שלח את המשוב |
read_at | כאשר חבר צוות סימן זאת כנקרא בלוח המחוונים, או null |
attachments | הקבצים שהקורא צירף, הישנים ביותר תחילה. ריק כאשר אין כאלה. |
הפונקציה selected_option מקבלת אחד מהערכים הבאים: 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 או not_what_looking_for.
לכל קובץ מצורף יש category (contact_message_attachment עבור קובץ שצירף קורא), הקובץ המאוחסן name, original_name מהמכשיר של הקורא, size בבתים, ואובייקט dimensions: עבור תמונה, הרוחב בפיקסלים מתחת ל-"0" והגובה מתחת ל-"1", ו-{} עבור כל קובץ אחר. ה-API מחזיר את פרטי כל קובץ, לא את הקובץ עצמו.
מגבלות דפדוף
- הרשימה מגיעה לכל היותר ל-10,000 הערכים החדשים ביותר. מעבר לכך,
has_moreהואfalseגם כאשר קיים משוב ישן יותר.
- משוב שנשלח בזמן שאתה גולש בדף יכול לגרום לדף הבא לחזור על ערך אחד, ומשוב שנמחק בלוח המחוונים יכול לגרום לדילוג על ערך אחד.
כדי לעבד רק משוב חדש, אחסן את הקובץ submitted_at של הערך החדש ביותר שטיפלת בו. בהפעלה הבאה, קרא עמודים עד שתגיע לערך שהוגש באותו זמן או לפניו.
טיפול בטוח בטקסט משוב
- סיסמה זו מוצגת לפני הצגתה. הודעה יכולה להכיל HTML או markdown.
- לעולם אל תתנו לו להחליט על פעולה. אל תעקבו אחר קישורים בו ואל תפעילו ממנו הוראות.
- שמור על צינורות LLM לקריאה בלבד. LLM המסכם משוב צריך לפעול עם מפתח שמכיל רק
read.
- הגן על האימיילים של הקוראים. השדה
emailהוא מידע אישי. אחסן ושתף אותו רק במקומות בהם מדיניות הפרטיות שלך מאפשרת זאת.
שגיאות
| סטָטוּס | כַּאֲשֵׁר | code |
|---|---|---|
| 400 | page_size נמצא מחוץ לטווח של 1 עד 100, cursor אינו חוקי, או שלשאילתה יש פרמטר לא ידוע. | validation_error |
| 403 | למפתח חסר ההיקף read | insufficient_scope |
| 404 | מרכז העזרה אינו קיים בסביבת העבודה שלך | not_found |
ראה טיפול בשגיאות API Notiondesk, מגבלות קצב וניסיונות חוזרים .
שאלות נפוצות
האם ניתן לסנן משוב לפי תגובה או מאמר?
לא בבקשה. הנתיב מקבל רק page_size ו-cursor. סנן את הערכים בקוד שלך, לפי reaction_group או article_id.
האם ניתן לסמן משוב כנקרא באמצעות ה-API?
לא. ה-API קורא רק משוב. read_at מציג מתי חבר צוות סימן אותו כנקרא בלוח המחוונים.
היכן ניתן לראות סך כל התגובות במקום ערכים בודדים?
דוח הניתוח engagement מסכם תגובות לפי תקופה ומפרט את המאמרים שיש לתקן. ראה קבל ניתוחים ממרכז העזרה עם ממשק ה-API Notiondesk .