Ferndesk

Analytics

Analytics pro Artikel abrufen

Ansichten, eindeutige Betrachter, Suchauswahlen und Feedback-Zählungen pro veröffentlichtem Artikel. Die Metriken werden aus der Analytics-Pipeline berechnet und können während eines Pipeline-Ausfalls den Wert null aufweisen, anstatt einen Fehler zu verursachen. Erfordert den Bereich analytics:read.

Erforderlicher Bereich: analytics:read

GET /analytics/articles

Analytics pro Artikel abrufen

curl --request GET \
  --url 'https://api.ferndesk.com/v1/analytics/articles' \
  --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 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 Bereiche beschränkt werden (jeder Endpunkt führt den erforderlichen Bereich ü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, die Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Berichte, Analytics 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. Vor der Einführung der Bereichsbeschränkung erstellte Schlüssel haben null Bereiche und somit vollständigen Zugriff (Legacy-Modus).

Query Parameters

  • end_date string

    Obere Grenze für das ISO-Datum.

  • limit integer

    Zeilenlimit für Analytics-Listen.

  • start_date string

    Untere Grenze für das ISO-Datum.

Response

application/json
  • [key: string] any additional