Ferndesk

Obtenir un rapport

Renvoie les chiffres d’un rapport pour une plage, tels que Reporting les affiche dans Ferndesk : support_overview, ai_agent et satisfaction pour Support et l’agent IA, et help_center, searches et articles pour le centre d’aide. Chaque chiffre comprend une série quotidienne et, avec compare, sa valeur sur la période précédant la plage.

GET /v1/reports/{name}
Jeton Bearer portée reports:read

Paramètres de chemin

· 1
name string · énumération requis

valeurs

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

Paramètres de requête

· 3
from string | string requis

Début de la plage, inclusif : un horodatage ISO 8601 ou un jour au format YYYY-MM-DD (minuit UTC).

to string | string requis

Fin de la plage, exclusive. Au plus 190 jours après from.

compare string · par défaut : false· énumération

Renvoyer également chaque métrique pour une période de même durée précédant immédiatement la plage.

valeurs

  • true
  • false

Réponses