Obtenez des analyses du centre d'assistance avec l'API Notiondesk

L'API Notiondesk vous fournit les données clés des pages d'analyse de votre centre d'aide : visiteurs, nombre de vues d'articles, temps passé sur la page, pays d'origine, requêtes des lecteurs, recherches infructueuses et réactions des lecteurs à vos articles. Utilisez-la pour alimenter un outil de BI, publier un rapport hebdomadaire sur Slack ou identifier le contenu que vos lecteurs pourraient manquer.

GET /sites/{site_id}/analytics/{report}

Chaque rapport doit inclure le périmètre read. Pour consulter ces chiffres dans le tableau de bord, reportez-vous à la section « Comment améliorer votre centre d’aide grâce aux informations des lecteurs » .

Obtenez un résumé sur 30 jours

quick couvre les 30 derniers jours et ne prend aucun paramètre de requête. articles comptabilise tous les articles du centre d'aide, brouillons compris. reactions comptabilise la dernière réaction de chaque lecteur pour chaque article.

Obtenez un rapport pour une plage de dates.

overview, search et engagement prennent une plage de dates et une taille de compartiment :

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/quick" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "articles": 42,
  "visitors": 25,
  "searches": 9,
  "reactions": 4
}

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/search?start_date=2026-09-01T00:00:00Z&end_date=2026-10-01T00:00:00Z&date_scale=week&timezone=Europe/Paris" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Règles relatives au stand de tir :

• Les dates utilisent le format YYYY-MM-DDTHH:MM[:SS] avec un décalage optionnel. Sans décalage, la date est lue en UTC et non au format timezone. Dans l'URL, indiquez + comme %2B ou utilisez Z.

• La période concernée commence le 1er janvier 2020 ou après et se termine au plus tard dans deux jours.

• Au maximum 1 000 intervalles. Par exemple, minute couvre au maximum 16 heures et hour au maximum 41 jours. Utilisez un intervalle plus large, date_scale, pour les périodes plus longues.

• Les semaines commencent le lundi.

Chaque rapport compare votre plage avec la période de même longueur juste avant : previous et total_previous décrivent cette période antérieure.

Série de comptes

visitors, article_views et searches partagent une même forme :

{
  "total": 12,
  "total_previous": 8,
  "difference": 4,
  "percentage_difference": 50.0,
  "current": [{"date": "2026-09-14", "count": 7}, {"date": "2026-09-15", "count": 5}],
  "previous": [{"date": "2026-08-20", "count": 8}]
}

• current et previous listent uniquement les compartiments qui contiennent des données, du plus ancien au plus récent.

• Le date d'un seau est son point de départ, dans timezone : YYYY-MM-DD pour day et plus grossier, YYYY-MM-DDTHH:MM pour hour et minute.

• percentage_difference est 0.0 lorsque le total précédent est 0.

overview

search

{
  "searches_without_results": {
    "total": 3,
    "total_previous": 0,
    "difference": 3,
    "percentage_difference": 0.0,
    "queries": [{"query": "refund policy", "searches": 3}]
  }
}

Remarque : votre backlog de contenu correspond à une question posée par les lecteurs et à laquelle votre centre d’aide n’a pas pu répondre. searches_without_results.queries

engagement

Un reaction_summary suit votre style de réaction :

La variable score varie de 0 à 100 : elle représente la part des réactions positives, une réaction neutre comptant pour la moitié (voir emoji). Avec le format thumbs, les groupes sont helpful et not_helpful. Voir « Comment recueillir des commentaires sur les articles » .

Limites de la liste

{
  "style": "emoji",
  "total": 6,
  "score": 58,
  "groups": [
    {"key": "positive", "count": 3, "percent": 50},
    {"key": "neutral", "count": 1, "percent": 17},
    {"key": "negative", "count": 2, "percent": 33}
  ]
}

• Les listes de requête top_articles, top_referrers, article_engagements et articles_to_revise contiennent chacune jusqu'à 50 lignes et couvrent uniquement la période actuelle. Une liste de 50 lignes peut être incomplète : réduisez la plage pour afficher toutes les lignes.

• Les totaux couvrent l'ensemble des données, et pas seulement les lignes listées.

titleCes URL proviennent des navigateurs des visiteurs et peuvent être falsifiées par n'importe qui. Il est impératif de les ignorer avant de les afficher et de ne jamais les suivre ni agir en conséquence sans les vérifier.urlhostpathnamereferrerquery

L'analyse et votre plan

L'accès à l'API nécessite un forfait Entreprise, qui inclut des analyses avancées, de sorte que chaque rapport accepte n'importe quelle plage et échelle dans 1 000 compartiments.

Limite de débit

Outre les 120 lectures par minute de votre clé, les rapports d'analyse sont comptabilisés dans un budget de 30 requêtes par minute et par centre d'aide , partagé par chaque clé et application OAuth de votre espace de travail. Une requête adressée à ce centre d'aide renvoie une réponse 429 rate_limited, et son en-tête Retry-After indique quand réessayer. Il est recommandé de mettre les rapports en cache plutôt que de les demander à chaque chargement de page.

Erreurs

Voir Handle Notiondesk API errors, rate limits, and retries .

Questions fréquentes

Et ensuite ?

• Exportez les commentaires des lecteurs avec l'API Notiondesk

• Automatisez les tâches courantes du centre d'assistance grâce à l'API Notiondesk

• Gérer les erreurs, les limites de débit et les nouvelles tentatives de l'API Notiondesk