קבל ניתוח נתונים ממרכז העזרה עם ממשק ה-API Notiondesk

ממשק ה-API Notiondesk מספק לכם את הנתונים מאחורי דפי הניתוח של מרכז העזרה שלכם: מבקרים, צפיות במאמרים, זמן שהייה בדף, מדינות, מה הקוראים מחפשים, אילו חיפושים לא מצאו דבר, וכיצד הקוראים מגיבים למאמרים שלכם. השתמשו בו כדי להזין כלי בינה עסקית, לפרסם דוח שבועי ב-Slack, או למצוא את התוכן שהקוראים שלכם מפספסים.

GET /sites/{site_id}/analytics/{report}

כל דוח זקוק להיקף read. כדי לקרוא את המספרים הללו בלוח המחוונים, ראה כיצד לשפר את מרכז העזרה שלך בעזרת תובנות קוראים .

קבל סיכום של 30 יום

quick מכסה את 30 הימים האחרונים שהסתיימו כעת ואינו מקבל פרמטר שאילתה. articles סופר כל מאמר במרכז העזרה, כולל טיוטות. reactions סופר את התגובה האחרונה של כל קורא לכל מאמר.

קבל דוח עבור טווח תאריכים מסוים

overview, search ו-engagement מקבלים טווח תאריכים וגודל קטגוריית נתונים:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/quick" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "articles": 42,
  "visitors": 25,
  "searches": 9,
  "reactions": 4
}

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/search?start_date=2026-09-01T00:00:00Z&end_date=2026-10-01T00:00:00Z&date_scale=week&timezone=Europe/Paris" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

חוקים לטווח:

• תאריכים משתמשים ב-YYYY-MM-DDTHH:MM[:SS] עם היסט אופציונלי. ללא היסט, התאריך נקרא כ-UTC, ולא כ-timezone. כתבו + כ-%2B בכתובת האתר, או השתמשו ב-Z.

• הטווח מתחיל ב-1 בינואר 2020 או אחריו ומסתיים לכל היותר יומיים מהיום.

• לכל היותר 1,000 דליים. לדוגמה, minute מכסה לכל היותר 16 שעות ו-hour לכל היותר 41 ימים. השתמש ב-date_scale גס יותר עבור טווחים ארוכים יותר.

• שבועות מתחילים ביום שני.

כל דוח משווה את הטווח שלך לתקופה באותו אורך ממש לפניו: previous ו-total_previous מתארים את התקופה המוקדמת יותר.

סדרת ספירה

ל-visitors, ל-article_views ול-searches יש צורה אחת:

{
  "total": 12,
  "total_previous": 8,
  "difference": 4,
  "percentage_difference": 50.0,
  "current": [{"date": "2026-09-14", "count": 7}, {"date": "2026-09-15", "count": 5}],
  "previous": [{"date": "2026-08-20", "count": 8}]
}

• הפונקציות current ו-previous מפרטות רק את הדליים שמכילים נתונים, כאשר הישנים ביותר תחילה.

• date של דלי הוא כאשר הוא מתחיל, ב-timezone: YYYY-MM-DD עבור day וגס יותר, YYYY-MM-DDTHH:MM עבור hour ו-minute.

• percentage_difference הוא 0.0 כאשר הסכום הכולל הקודם הוא 0.

overview

search

{
  "searches_without_results": {
    "total": 3,
    "total_previous": 0,
    "difference": 3,
    "percentage_difference": 0.0,
    "queries": [{"query": "refund policy", "searches": 3}]
  }
}

הערה: האם מדובר בצירוף תוכן? כל שאילתה היא שאלה שנשאלו על ידי הקוראים ומרכז העזרה שלכם לא הצליח לענות עליה. searches_without_results.queries

engagement

reaction_summary עוקב אחר סגנון התגובה שלך:

הערך score נע בין 0 ל-100: שיעור התגובות החיוביות, כאשר תגובה ניטרלית סופרת חצי מתחת ל-emoji. עם הסגנון thumbs, הקבוצות הן helpful ו-not_helpful. ראה כיצד לאסוף משוב עם תגובות למאמר .

מגבלות רשימה

{
  "style": "emoji",
  "total": 6,
  "score": 58,
  "groups": [
    {"key": "positive", "count": 3, "percent": 50},
    {"key": "neutral", "count": 1, "percent": 17},
    {"key": "negative", "count": 2, "percent": 33}
  ]
}

• רשימות השאילתות, top_articles, top_referrers, article_engagements ו-articles_to_revise מכילות עד 50 שורות כל אחת ומכסות את התקופה הנוכחית בלבד. רשימה של 50 שורות עשויה להיות חלקית: צמצם את הטווח כדי לראות כל שורה.

• הסכומים כוללים הכל, לא רק את השורות המפורטות.

title, , , , ומגיעים מדפדפני הגולשים, וכל אחד יכול לזייף אותם. יש להימנע מהם לפני הצגתם, ולעולם אל תפעלו על פיהם או תעקוב אחריהם ללא בדיקה.urlhostpathnamereferrerquery

אנליטיקס והתוכנית שלך

גישת API דורשת תוכנית ארגונית, הכוללת ניתוחים מתקדמים, כך שכל דוח מקבל כל טווח וקנה מידה בטווח של 1,000 קטגוריות.

מגבלת קצב

מלבד 120 קריאות לדקה של המפתח שלך, דוחות ניתוח נתונים לתקציב של 30 בקשות לדקה לכל מרכז עזרה , המשותף לכל מפתח ואפליקציית OAuth בסביבת העבודה שלך. בקשה דרכו עונה על 429 rate_limited, והכותרת Retry-After שלו מציינת מתי לנסות שוב. אחסן דוחות במטמון במקום לבקש אותם בכל טעינת דף.

שגיאות

ראה טיפול בשגיאות API Notiondesk, מגבלות קצב וניסיונות חוזרים .

שאלות נפוצות

מה הלאה

• ייצוא משוב קוראים באמצעות ממשק ה-API Notiondesk

• אוטומציה של משימות נפוצות במרכז העזרה בעזרת ממשק ה-API Notiondesk

• טיפול בשגיאות API, מגבלות קצב וניסיונות חוזרים של Notiondesk