Ferndesk

Analysen

Suchanalysen abrufen

Häufigste und nicht gefundene (ohne Ergebnis) Suchbegriffe mit Ergebnissen. Metriken werden aus der Analytics-Pipeline berechnet und können während eines Pipeline-Ausfalls als null angezeigt werden, anstatt einen Fehler zu verursachen. Erfordert den Scope analytics:read.

Erforderlicher Scope: analytics:read

GET /analytics/searches

Suchanalysen abrufen

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

Analytics-Nutzlast

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: Hilfe-Center-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, die Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analysen und Artikel-Feedback des Hilfe-Centers 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 ausgestellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Query Parameters

  • end_date string

    Obere Grenze für das ISO-Datum.

  • limit integer

    Zeilenlimit für listenartige Analysen.

  • start_date string

    Untere Grenze für das ISO-Datum.

Response

application/json
  • [key: string] any additional