L'API Analytics vous donne, par programme, les chiffres de la page Accueil de Kanal : chiffre d'affaires et commandes attribués à WhatsApp, coût des messages, ROAS et entonnoir d'engagement. Vous pouvez les récupérer pour tout le compte, ou pour une campagne ou une automatisation précise. Elle sert par exemple à alimenter un tableau de bord interne ou un outil de BI (Looker Studio, Power BI, Google Sheets...).
Un abonnement Kanal actif : sans abonnement, chaque appel répond 403.
Votre clé API, la même que pour le reste de l'API, envoyée dans l'en-tête Authorization: Bearer <votre clé API>. La clé donne accès aux chiffres de tout le compte Kanal dans lequel elle a été créée.
Pour créer une clé, voir Authentification et clés API.
Méthode | Chemin | Rôle |
|---|---|---|
GET |
| Indicateurs du compte : chiffre d'affaires, coût, ROAS, entonnoir, répartition par source, top 5 campagnes et automatisations |
GET |
| Valeurs jour par jour d'un indicateur |
GET |
| Statistiques d'une campagne |
GET |
| Statistiques d'une automatisation, avec le détail par étape |
GET |
| Liste des campagnes (avec leur id) |
GET |
| Liste des automatisations (avec leur id) |
Les identifiants à passer aux routes de statistiques viennent des deux listes, ou du bloc top de l'aperçu du compte.
curl "https://api.getkanal.com/api/v1/stats/overview?time_range=last_30_days&compared_to=previous_period" \
-H "Authorization: Bearer VOTRE_CLE_API"Toutes les routes de statistiques acceptent les mêmes paramètres :
time_range : today, week_to_date, last_7_days, month_to_date, last_30_days (par défaut), last_3_months, last_6_months, year_to_date, all_time ou custom.
start_date et end_date (format AAAA-MM-JJ), uniquement avec time_range=custom.
compared_to : previous_period, previous_year ou custom (avec compare_start_date et compare_end_date). Chaque indicateur reçoit alors sa valeur précédente et son évolution en %.
Les jours sont comptés dans le fuseau horaire du compte, bornes incluses. Chaque réponse rappelle la période réellement utilisée.
Aperçu du compte : chiffre d'affaires, ROAS, coût total et coût marketing, conversations, commandes attribuées, chiffre d'affaires par destinataire, messages délivrés, entonnoir (délivrés, lus, interactions avec clics et réponses, convertis), répartition du chiffre d'affaires entre campagnes, automatisations et Agent IA, top 5 des campagnes et des automatisations.
Série temporelle : un indicateur par jour avec le paramètre metric : revenue (par défaut), orders, conversations, cost, delivered, read, roas ou conversion_rate. Les jours sans donnée peuvent manquer : comptez-les à 0.
Campagne : chiffre d'affaires, ROAS, commandes, coût, messages délivrés, taux de conversion, chiffre d'affaires par destinataire et entonnoir. Le chiffre d'affaires est compté au jour de la commande : pour le résultat complet d'une campagne, choisissez une période qui commence le jour de l'envoi et couvre la fenêtre d'attribution.
Automatisation : les mêmes chiffres, plus le détail par étape (nodes) : chiffre d'affaires, commandes, ROAS, messages envoyés, délivrés, lus, cliqués et contacts entrés dans l'étape.
Attribution : les chiffres suivent vos réglages de Paramètres > Attribution (fenêtre de 5 jours et base « Délivré » par défaut). Ils correspondent à ceux affichés dans Kanal.
Devise : chiffre d'affaires et coût sont toujours en euros, quelle que soit la devise de la boutique.
Fraîcheur : l'attribution est recalculée toutes les 15 minutes, les 30 dernières minutes peuvent encore bouger. Inutile d'interroger l'API plus souvent que toutes les 15 minutes.
60 requêtes par minute et par clé API, partagées entre les 6 routes. Au-delà, l'API répond 429 avec un en-tête Retry-After.
Code | Cause |
|---|---|
401 | Clé API absente ou invalide |
403 | Pas d'abonnement actif |
404 | Campagne ou automatisation inconnue, ou appartenant à un autre compte |
422 | Paramètre de période ou de métrique invalide |
429 | Trop de requêtes |
La documentation technique complète, avec tous les champs de réponse : developers.getkanal.com/docs/analytics.