Ferndesk

Analyses

Obtenir les analyses de recherche

Termes de recherche les plus fréquents et sans résultat (aucun résultat), avec leurs résultats. Les métriques sont calculées par le pipeline d’analytique et peuvent être égales à zéro en cas d’interruption du pipeline, plutôt que de générer une erreur. Nécessite la portée analytics:read.

Portée requise : analytics:read

GET /analytics/searches

Obtenir les analyses de recherche

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

Charge utile des analyses

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Paramètres de développement.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces portées (chaque endpoint indique la portée requise via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier des brouillons d’articles, des utilisateurs et des tâches ; déplacer des articles et des collections
    • content:publish : Publier, dépublier, restaurer et supprimer définitivement du contenu (rendre les modifications effectives)
    • analytics:read : Lire les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    L’octroi de content:write ou content:publish implique content:read. Les clés créées avant la mise en place des portées ont des portées nulles = accès complet (mode hérité).

Query Parameters

  • end_date string

    Limite supérieure de date au format ISO.

  • limit integer

    Limite de lignes pour les analyses de type liste.

  • start_date string

    Limite inférieure de date au format ISO.

Response

application/json
  • [key: string] any additional