> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chataigne.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Présentation des analyses

> Choisissez une ressource analytique ciblée et découvrez les filtres et conventions communs à toutes les réponses.

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.

| Domaine                   | Endpoint établissement                             | Endpoint organisation                                      |
| ------------------------- | -------------------------------------------------- | ---------------------------------------------------------- |
| Finances                  | `/v1/locations/{location_id}/analytics/financials` | `/v1/organizations/{organization_id}/analytics/financials` |
| Commandes                 | `/v1/locations/{location_id}/analytics/orders`     | `/v1/organizations/{organization_id}/analytics/orders`     |
| Clients                   | `/v1/locations/{location_id}/analytics/customers`  | `/v1/organizations/{organization_id}/analytics/customers`  |
| Livraison                 | `/v1/locations/{location_id}/analytics/delivery`   | `/v1/organizations/{organization_id}/analytics/delivery`   |
| Produits                  | `/v1/locations/{location_id}/analytics/products`   | `/v1/organizations/{organization_id}/analytics/products`   |
| Remises                   | `/v1/locations/{location_id}/analytics/discounts`  | `/v1/organizations/{organization_id}/analytics/discounts`  |
| Ventilation par périmètre | `/v1/locations/{location_id}/analytics/channels`   | `/v1/organizations/{organization_id}/analytics/locations`  |

<CardGroup cols={2}>
  <Card title="Finances" icon="coins" href="/fr/analytics/financials">
    Chiffre d'affaires et panier moyen.
  </Card>

  <Card title="Commandes" icon="receipt" href="/fr/analytics/orders">
    Volume de commandes et distributions temporelles.
  </Card>

  <Card title="Clients" icon="users" href="/fr/analytics/customers">
    Acquisition, fidélisation, interactions et conversion.
  </Card>

  <Card title="Livraison" icon="truck" href="/fr/analytics/delivery">
    Échecs, coûts, frais et villes de livraison.
  </Card>

  <Card title="Produits" icon="burger" href="/fr/analytics/products">
    Volume d'articles, meilleures ventes et tendances.
  </Card>

  <Card title="Remises" icon="badge-percent" href="/fr/analytics/discounts">
    Utilisations et montants accordés.
  </Card>

  <Card title="Ventilations" icon="chart-pie" href="/fr/analytics/breakdowns">
    Canaux d'un établissement et établissements d'une organisation.
  </Card>
</CardGroup>

## Authentification et accès

Envoyez votre clé API dans l'en-tête `x-api-key`. Elle doit inclure l'autorisation `analytics.read`.

| Portée de la clé         | Analyses d'un établissement  | Analyses d'une organisation |
| ------------------------ | ---------------------------- | --------------------------- |
| Établissement            | Son établissement uniquement | Non autorisé                |
| Organisation commerciale | Tout établissement enfant    | Son organisation            |

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

<ParamField query="from" type="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.
</ParamField>

<ParamField query="to" type="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.
</ParamField>

<ParamField query="service_type" type="string">
  Filtre facultatif sur le service de commande : `delivery` ou `collection`.
</ParamField>

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](/fr/analytics/financials) 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.
