Ferndesk

Feedback

Feedback abrufen

Gibt einen einzelnen Feedback-Eintrag zurück. Erfordert den Scope analytics:read.

Erforderlicher Scope: analytics:read

GET /feedback/{id}

Feedback abrufen

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

Feedback

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel tragen das Präfix fdsk_ und sollten 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: Hilfecenter-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 im Hilfecenter 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 der Bereichsbegrenzung ausgestellte Schlüssel haben null scopes = vollständiger Zugriff (Legacy-Modus).

Path Parameters

  • id string erforderlich

Response

application/json
  • 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 Help-Center-Benutzer, der automatisch anhand der E-Mail-Adresse des Einsenders zugeordnet wurde (eindeutig anhand von E-Mail-Adresse + Helpdesk), oder null, wenn der Einsender 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-Hilfecenter-Benutzer-ID (hcusr_...).

        • name string | null

          Anzeigename des Hilfecenter-Benutzers.

        • email string (email)

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

      • option 2 null