Ferndesk

Analysen

Feedback-Analysen abrufen

KPIs zur Hilfreichkeit und Zusammenfassung des aktuellen Feedbacks. Für eine paginierte, priorisierbare Feedback-Ressource verwenden Sie /feedback. Metriken werden aus der Analysepipeline berechnet und können während eines Ausfalls der Pipeline den Wert null aufweisen, statt einen Fehler zurückzugeben. Erfordert den Scope analytics:read.

Erforderlicher Scope: analytics:read

GET /analytics/feedback

Feedback-Analysen abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/analytics/feedback' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "key": "<string>"
}

Analyse-Nutzdaten

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der 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 des Hilfecenters 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 schließt content:read ein. Schlüssel, die vor der Einführung von Scopes erstellt wurden, haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Query Parameters

  • end_date string

    Obere Grenze für ein ISO-Datum.

  • start_date string

    Untere Grenze für ein ISO-Datum.

Response

application/json
  • [key: string] any additional