Skip to main content
L’API Analytics expose des ressources courtes et prévisibles pour un établissement ou toute une organisation commerciale. Appelez le domaine métier dont vous avez besoin au lieu de sélectionner des champs dans une réponse volumineuse.

Finances

Chiffre d’affaires et panier moyen.

Commandes

Volume de commandes et distributions temporelles.

Clients

Acquisition, fidélisation, interactions et conversion.

Livraison

Échecs, coûts, frais et villes de livraison.

Produits

Volume d’articles, meilleures ventes et tendances.

Remises

Utilisations et montants accordés.

Ventilations

Canaux d’un établissement et établissements d’une organisation.

​
Authentification et accès

Envoyez votre clé API dans l’en-tête x-api-key. Elle doit inclure l’autorisation analytics.read. Une clé valide sans accès à la ressource demandée reçoit une erreur 403. Un identifiant canonique inconnu reçoit une erreur 404.

​
Filtres communs

​
string
Début de la période sous forme d’horodatage ISO 8601. Si from et to sont omis, la période commence 30 jours avant la requête.
​
string
Fin de la période sous forme d’horodatage ISO 8601. Si from et to sont omis, la période se termine lors du traitement de la requête.
​
string
Filtre facultatif sur le service de commande : delivery ou collection.
Chaque réponse rappelle les filtres effectifs dans period. Il n’existe pas de paramètre de sélection des indicateurs : chaque endpoint renvoie toujours son schéma complet et fixe.

​
Conventions de données

  • Les statistiques liées aux commandes couvrent les commandes confirmées et en cours passées sur Chataigne via WhatsApp ou Instagram. Les commandes et livraisons échouées apparaissent uniquement dans leurs champs dédiés.
  • Les réponses monétaires d’un établissement incluent currency. Celles d’une organisation utilisent by_currency : des montants dans des devises différentes ne sont jamais additionnés.
  • Les valeurs quotidiennes et horaires utilisent le fuseau horaire configuré pour chaque établissement. Une journée d’organisation suit donc le jour calendaire local de chaque établissement contributeur.
  • Les taux sont des pourcentages de 0 à 100, et non des fractions décimales.
  • Les séries quotidiennes utilisent des lignes explicites telles que { "date": "2026-06-01", "order_count": 12 }. Les dates sans valeur ne sont pas renvoyées sous forme de lignes à zéro.
Commencez par les analyses financières ou ouvrez la référence générée de l’API Analytics pour consulter tous les schémas de requête et de réponse.