Ferndesk

Feedback

Feedback zu Artikeln auflisten

Cursor-paginierte Rückmeldungen zu Artikeln mit Filtern (article_id, type, resolved). Erfordert den Scope analytics:read.

Erforderlicher Scope: analytics:read

GET /feedback

Feedback zu Artikeln auflisten

curl --request GET \
  --url 'https://api.ferndesk.com/v1/feedback' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "results": [
    {
      "id": "<string>",
      "articleId": "<string>",
      "articleTitle": "<string>",
      "type": "positive",
      "feedback": "<string>",
      "email": "<string>",
      "resolved": true,
      "createdAt": "<string>",
      "user": {}
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Feedback-Seite

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel tragen das Präfix fdsk_ und müssen geheim gehalten werden. Sie können Schlüssel über die Seite Entwicklereinstellungen erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfezentrum-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, deren Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfezentrums lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von Scopes erstellte Schlüssel haben null Scopes und somit vollständigen Zugriff (Legacy-Modus).

Query Parameters

  • article_id string

    Nach Artikel filtern.

  • page_size integer

    Anzahl der pro Seite zurückzugebenden Elemente (1–100). Beispiel: 20

  • resolved string enum

    Nach Erledigungsstatus filtern.

  • start_cursor string

    Opaker Paginierungscursor. Übergeben Sie den next_cursor aus einer vorherigen Antwort, um die nächste Seite abzurufen. Beispiel: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

  • type string enum

    Nach Feedback-Typ filtern.

Response

application/json
  • results[] object array

    Elemente auf dieser Seite. Feedback-Eintrag zu einem Artikel.

    + Show Child Attributes
    • id string
    • articleId string | null
    • articleTitle string | null
    • type string enum enum

      Allowed values: positive, negative.

    • feedback string
    • email string | null
    • resolved boolean
    • createdAt string

      ISO-8601-Zeitstempel in UTC.

    • user anyOf

      Der anhand der E-Mail-Adresse des Einreichenden automatisch zugeordnete Benutzer des Hilfezentrums (eindeutig nach E-Mail-Adresse und Helpdesk) oder null, wenn der Einreichende anonym oder nicht erkannt ist.

      + Show Child Attributes
      • anyOf options 2 variants anyOf

        One or more options can apply.

        + Show Child Attributes
        • option 1 object
          + Show Child Attributes
          • id string

            Ferndesk-Hilfezentrum-Benutzer-ID (hcusr_...).

          • name string | null

            Anzeigename des Hilfezentrum-Benutzers.

          • email string (email)

            E-Mail-Adresse des Hilfezentrum-Benutzers. E-Mail-Adressen werden in Kleinbuchstaben gespeichert.

        • option 2 null
  • has_more boolean

    Gibt an, ob nach dieser Seite weitere Elemente verfügbar sind.

  • next_cursor string | null

    Cursor, der als start_cursor für die nächste Seite übergeben wird, oder null auf der letzten Seite.