Ferndesk

Bericht abrufen

Gibt die Kennzahlen eines Berichts für einen Zeitraum zurück, so wie Reporting sie in Ferndesk anzeigt: support_overview, ai_agent und satisfaction für Support und den AI agent sowie help_center, searches und articles für das Help Center. Zu jeder Kennzahl gehört eine tägliche Zeitreihe und bei compare auch ihr Wert für den Zeitraum unmittelbar vor dem angegebenen Zeitraum.

GET /v1/reports/{name}
Bearer-Token Scope reports:read

Pfadparameter

· 1
name string · Enum erforderlich

Werte

  • support_overview
  • ai_agent
  • satisfaction
  • help_center
  • searches
  • articles

Query-Parameter

· 3
from string | string erforderlich

Beginn des Zeitraums, einschließlich: ein ISO 8601-Zeitstempel oder ein Tag im Format YYYY-MM-DD (Mitternacht UTC).

to string | string erforderlich

Ende des Zeitraums, ausschließlich. Höchstens 190 Tage nach from.

compare string · Standard: false· Enum

Gibt jede Kennzahl zusätzlich für den unmittelbar vor dem Zeitraum liegenden Zeitraum gleicher Länge zurück.

Werte

  • true
  • false

Antworten