Ferndesk

Analytics

Analytics-Übersicht abrufen

KPIs zu Besuchern, Aufrufen und Suchvorgängen mit täglichem Verlauf. Metriken werden aus der Analytics-Pipeline berechnet und können während eines Ausfalls der Pipeline den Wert 0 anzeigen, statt einen Fehler zu verursachen. Erfordert den analytics:read-Scope.

Erforderlicher Scope: analytics:read

GET /analytics/overview

Analytics-Übersicht abrufen

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

Analytics-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 listet 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, deren Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Hilfe-Center-Reporting, Analytics und Artikel-Feedback 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 = vollständiger Zugriff (Legacy-Modus).

Query Parameters

  • end_date string

    Obere Grenze für das ISO-Datum.

  • start_date string

    Untere Grenze für das ISO-Datum.

Response

application/json
  • [key: string] any additional