Erhalten Sie Hilfecenter-Analysen mit der Notiondesk API

Die Notiondesk API liefert Ihnen die Kennzahlen hinter den Analyseseiten Ihres Hilfecenters: Besucherzahlen, Artikelaufrufe, Verweildauer, Herkunftsländer, Suchanfragen der Leser, erfolglose Suchanfragen und Leserreaktionen auf Ihre Artikel. Nutzen Sie die Daten, um ein BI-Tool zu speisen, einen wöchentlichen Bericht in Slack zu veröffentlichen oder herauszufinden, welche Inhalte Ihre Leser vermissen.

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

Jeder Bericht benötigt den Bereich read. Um diese Zahlen im Dashboard anzuzeigen, lesen Sie bitte den Artikel „So verbessern Sie Ihr Hilfecenter mithilfe von Lesereinblicken“ .

Erhalten Sie eine 30-Tage-Zusammenfassung

quick umfasst die letzten 30 Tage bis heute und benötigt keine Abfrageparameter. articles zählt alle Artikel des Hilfecenters, einschließlich Entwürfe. reactions zählt die jeweils letzte Reaktion jedes Lesers auf einen Artikel.

Erhalten Sie einen Bericht für einen bestimmten Datumsbereich

overview, search und engagement benötigen einen Datumsbereich und eine Bucket-Größe:

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"

Regeln für den Schießstand:

• Datumsangaben werden im Format YYYY-MM-DDTHH:MM[:SS] mit einem optionalen Offset angegeben. Ohne Offset wird das Datum als UTC-Format und nicht im Format timezone interpretiert. Schreiben Sie + als %2B in der URL oder verwenden Sie Z.

• Der Zeitraum beginnt am oder nach dem 1. Januar 2020 und endet höchstens zwei Tage später.

• Maximal 1.000 Buckets. Beispielsweise deckt minute maximal 16 Stunden und hour maximal 41 Tage ab. Verwenden Sie für größere Zeiträume ein gröberes date_scale.

• Die Woche beginnt am Montag.

Jeder Bericht vergleicht Ihren Zeitraum mit dem gleich langen Zeitraum unmittelbar davor: previous und total_previous beschreiben diesen früheren Zeitraum.

Zählreihe

visitors, article_views und searches haben die gleiche Form:

{
  "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 und previous listen nur die Buckets auf, die Daten enthalten, beginnend mit dem ältesten.

• Der date eines Buckets ist der Zeitpunkt, an dem er beginnt, in timezone: YYYY-MM-DD für day und gröber, YYYY-MM-DDTHH:MM für hour und minute.

• percentage_difference ist 0.0, wenn die vorherige Summe 0 beträgt.

overview

search

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

Hinweis: Dies ist Ihr Content-Backlog: Jede Anfrage ist eine Frage, die Leser gestellt haben und die Ihr Hilfecenter nicht beantworten konnte. searches_without_results.queries

engagement

Ein reaction_summary entspricht Ihrem Reaktionsstil:

score reicht von 0 bis 100: der Anteil positiver Reaktionen, wobei neutrale Reaktionen unter emoji zur Hälfte gezählt werden. Im thumbs-Stil heißen die Gruppen helpful und not_helpful. Siehe „Wie man Feedback mit Artikelreaktionen sammelt“ .

Listenbeschränkungen

{
  "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}
  ]
}

• Die Abfragelisten top_articles, top_referrers, article_engagements und articles_to_revise enthalten jeweils bis zu 50 Zeilen und decken nur den aktuellen Zeitraum ab. Eine Liste mit 50 Zeilen ist möglicherweise unvollständig: Schränken Sie den Bereich ein, um alle Zeilen anzuzeigen.

• Die Summen umfassen alles, nicht nur die aufgeführten Zeilen.

titleDiese E-Mails stammen von den Browsern der Besucher und können von jedem gefälscht werden. Filtern Sie sie, bevor Sie sie anzeigen, und folgen oder reagieren Sie niemals unkontrolliert darauf.urlhostpathnamereferrerquery

Analysen und Ihr Plan

Für den API-Zugriff ist ein Enterprise-Plan erforderlich, der erweiterte Analysefunktionen beinhaltet, sodass jeder Bericht beliebige Bereiche und Skalierungen innerhalb von 1.000 Buckets akzeptiert.

Ratenbegrenzung

Neben den 120 Lesezugriffen pro Minute für Ihren Schlüssel werden Analyseberichte auf ein Budget von 30 Anfragen pro Minute und Hilfezentrum angerechnet, das von allen Schlüsseln und OAuth-Apps Ihres Arbeitsbereichs gemeinsam genutzt wird. Eine Anfrage wird mit dem Statuscode 429 rate_limited beantwortet, und der Header Retry-After gibt an, wann ein Wiederholungsversuch unternommen werden soll. Berichte werden zwischengespeichert, anstatt sie bei jedem Seitenaufruf neu anzufordern.

Fehler

Siehe Handle Notiondesk API-Fehler, Ratenbegrenzungen und Wiederholungsversuche .

Häufig gestellte Fragen

Was kommt als Nächstes?

• Exportieren Sie Leserfeedback mit der Notiondesk API

• Automatisieren Sie häufige Aufgaben im Hilfecenter mit der Notiondesk API

• Behandelt API-Fehler, Ratenbegrenzungen und Wiederholungsversuche der Klasse Notiondesk