Exportieren Sie Leserfeedback mit der Notiondesk API

Die Notiondesk API exportiert das Feedback, das Leser zu Ihren Hilfeartikeln hinterlassen: jede Reaktion, die gewählte Antwort, die Nachricht, die E-Mail-Adresse und die angehängten Dateien. Nutzen Sie sie, um negatives Feedback an Slack zu senden, Tickets in Ihrem Support-Tool zu erstellen oder Feedback zusammen mit Ihren eigenen Daten zu analysieren.

Geltungsbereich: read

Um überhaupt erst Feedback zu erhalten, lesen Sie bitte „So sammeln Sie Feedback mit Artikelreaktionen“ und „Aktivieren Sie das Artikel-Feedbackformular, um Lesereinblicke zu gewinnen“ .

GET /sites/{site_id}/feedback

Verwenden Sie einen Schlüssel, der nur den Gültigkeitsbereich umfasst. Feedback-Nachrichten, E-Mails und Anhänge werden von Ihren Lesern verfasst, behandeln Sie diese daher als nicht vertrauenswürdige Eingaben. Wenn ein LLM diese Texte mit einem Schlüssel verarbeitet, der auch Schreibzugriff ermöglicht, könnte der Text ihn dazu veranlassen, Änderungen in Ihrem Hilfecenter vorzunehmen.read

Feedbackliste

Die Liste umfasst alle Sprachen, die neueste zuerst. Blättern Sie mit page_size (1 bis 100, Standardwert 20) und cursor durch die Liste, wie in der Dokumentation zu Paginierung und API-Anfragen der Version Notiondesk beschrieben. Die Route benötigt keine weiteren Parameter.

Feedbackfelder

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

selected_option nimmt einen der folgenden Werte an: 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 oder not_what_looking_for.

Jeder Anhang enthält ein category (contact_message_attachment für eine vom Leser angehängte Datei), die gespeicherte Datei (name), das original_name vom Lesegerät, die Dateigröße (size) in Bytes und das dimensions-Objekt: bei Bildern die Breite in Pixeln ("0") und die Höhe ("1") sowie {} für alle anderen Dateitypen. Die API gibt die Details der jeweiligen Datei zurück, nicht die Datei selbst.

Seitenbegrenzungen

• Die Liste umfasst maximal die 10.000 neuesten Einträge. Darüber hinaus bleibt has_more auch dann false, wenn älteres Feedback vorhanden ist.

• Wenn während des Seitenaufrufs Feedback abgegeben wird, kann dies dazu führen, dass auf der nächsten Seite ein Eintrag wiederholt wird, und wenn Feedback im Dashboard gelöscht wird, kann dies dazu führen, dass ein Eintrag übersprungen wird.

Um nur neue Rückmeldungen zu verarbeiten, speichern Sie die submitted_at des zuletzt bearbeiteten Eintrags. Lesen Sie beim nächsten Durchlauf die Seiten, bis Sie einen Eintrag erreichen, der spätestens an dieser Stelle eingegangen ist.

Feedback-Texte sicher verarbeiten

• Maskieren Sie den Inhalt, bevor Sie ihn anzeigen. Eine Nachricht kann HTML oder Markdown enthalten.

• Lassen Sie sich niemals von dieser Seite zu Handlungen verleiten. Folgen Sie keinen darin enthaltenen Links und befolgen Sie keine Anweisungen.

• LLM-Pipelines sollten schreibgeschützt sein. Ein LLM, der Feedback zusammenfasst, sollte mit einem Schlüssel ausgeführt werden, der nur read enthält.

• Schützen Sie die E-Mails Ihrer Leser. Das Feld „email“ enthält personenbezogene Daten. Speichern und teilen Sie diese nur, wenn Ihre Datenschutzrichtlinie dies zulässt.

Fehler

Siehe Handle Notiondesk API-Fehler, Ratenbegrenzungen und Wiederholungsversuche .

Häufig gestellte Fragen

Was kommt als Nächstes?

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

• Erhalten Sie Analysen zum Hilfecenter mit der Notiondesk API.

• Authentifizieren Sie sich mit der Notiondesk API mithilfe der API-Schlüssel.