Ferndesk

Analyses

Obtenir les analyses par article

Comptes de vues, de visiteurs uniques, de sélections dans les recherches et de retours pour chaque article publié. Les métriques sont calculées à partir du pipeline d’analytique et peuvent être nulles pendant une panne du pipeline au lieu de générer une erreur. Requiert le scope analytics:read.

Scope requis : analytics:read

GET /analytics/articles

Obtenir les analyses par article

curl --request GET \
  --url 'https://api.ferndesk.com/v1/analytics/articles' \
  --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 développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble des scopes suivants (chaque endpoint indique le scope requis 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 mettre à la corbeille du contenu (rendre les modifications accessibles)
    • 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’attribution de content:write ou content:publish implique content:read. Les clés créées avant la mise en place des scopes ont des scopes nuls, ce qui accorde un accès complet (mode hérité).

Query Parameters

  • end_date string

    Limite supérieure de date au format ISO.

  • limit integer

    Nombre maximal 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