API publique

L'API publique de Fullmetrix renvoie vos indicateurs de ventes sous forme de tableau, au format JSON. Elle sert à alimenter un outil interne, un tableur automatisé, un entrepôt de données ou un tableau de bord maison. C'est elle qu'utilise le connecteur Looker Studio.

Une API est une adresse web que l'on interroge depuis un programme plutôt que depuis un navigateur. Vous envoyez une requête qui précise ce que vous voulez, par exemple le chiffre d'affaires par jour du mois dernier, et Fullmetrix répond avec les chiffres.

L'API est en lecture seule. Elle ne peut rien modifier dans Fullmetrix ni dans votre boutique.

Créer une clé APICopier le lien du titre

Chaque requête doit être accompagnée d'une clé API. La clé identifie l'organisation dont vous lisez les données. Il n'y a rien d'autre à configurer.

La liste des clés affiche pour chacune son Nom, son Préfixe, sa date de création dans Créée le et sa Dernière utilisation. Cette dernière colonne vous permet de repérer une clé qui ne sert plus. Pour couper une clé, cliquez sur Révoquer, puis confirmez. Toute intégration qui l'utilise cesse de fonctionner immédiatement. Le détail de cet écran est dans Clés API.

Créez une clé par outil. Si vous devez en couper une, les autres continuent de fonctionner.

S'authentifierCopier le lien du titre

L'adresse de base de l'API est https://app.fullmetrix.com. Chaque requête porte la clé dans l'en-tête Authorization, précédée du mot Bearer.

curl https://app.fullmetrix.com/api/reports/catalog \
  -H "Authorization: Bearer fmx_VOTRE_CLE"

Les clés fonctionnent pendant l'essai gratuit et pendant l'abonnement. Si l'abonnement de l'organisation s'arrête, les requêtes sont refusées jusqu'à sa reprise.

Lister les champs disponiblesCopier le lien du titre

GET /api/reports/catalog renvoie la liste des dimensions et des métriques que vous pouvez demander. Une dimension est un axe de découpage, comme la date ou le pays. Une métrique est un chiffre calculé, comme le nombre de commandes.

curl https://app.fullmetrix.com/api/reports/catalog \
  -H "Authorization: Bearer fmx_VOTRE_CLE"

{
  "dimensions": [
    { "id": "date", "label": "Date", "type": "date" },
    { "id": "store", "label": "Boutique", "type": "string" },
    { "id": "country", "label": "Pays", "type": "string" },
    { "id": "customer_type", "label": "Type client", "type": "string" },
    { "id": "status", "label": "Statut commande", "type": "string" }
  ],
  "metrics": [
    { "id": "orders", "label": "Commandes", "type": "number" },
    { "id": "items_sold", "label": "Produits vendus", "type": "number" },
    { "id": "gross_sales", "label": "CA brut", "type": "currency" },
    { "id": "net_revenue", "label": "CA net", "type": "currency" },
    { "id": "average_order_value", "label": "Panier moyen", "type": "currency" },
    { "id": "taxes", "label": "Taxes", "type": "currency" },
    { "id": "shipping", "label": "Livraison", "type": "currency" },
    { "id": "unique_customers", "label": "Clients uniques", "type": "number" },
    { "id": "new_customers", "label": "Nouveaux clients", "type": "number" },
    { "id": "returning_customers", "label": "Clients récurrents", "type": "number" }
  ]
}

Cet appel sert aussi à vérifier qu'une clé fonctionne. Il répond avec le code 200 si la clé est valide.

Les dimensionsCopier le lien du titre

Les métriquesCopier le lien du titre

Les montants sont exprimés dans la devise de vos boutiques et arrondis à deux décimales. Les chiffres suivent vos Paramètres de rapports, notamment les statuts exclus et les déductions des ventes nettes.

Interroger vos indicateursCopier le lien du titre

GET /api/reports/tabular renvoie un tableau de lignes. Chaque ligne combine les dimensions demandées et les métriques calculées pour cette combinaison.

ParamètresCopier le lien du titre

La période demandée peut couvrir jusqu'à deux ans. Au-delà, l'API la raccourcit en gardant la date de fin, et la réponse indique les dates réellement utilisées dans from et to.

Les dates from et to sont lues en temps universel, de minuit à minuit UTC. Le paramètre timezone change seulement le jour affiché pour chaque commande. Autour de minuit, quelques commandes peuvent donc différer d'un jour par rapport à vos rapports Fullmetrix.

Exemple, le chiffre d'affaires par jourCopier le lien du titre

curl "https://app.fullmetrix.com/api/reports/tabular?dimensions=date&metrics=orders,net_revenue&from=2026-09-01&to=2026-09-30&timezone=Europe/Paris" \
  -H "Authorization: Bearer fmx_VOTRE_CLE"

{
  "dimensions": ["date"],
  "metrics": ["orders", "net_revenue"],
  "from": "2026-09-01",
  "to": "2026-09-30",
  "timezone": "Europe/Paris",
  "rows": [
    { "date": "2026-09-01", "orders": 42, "net_revenue": 2318.4 },
    { "date": "2026-09-02", "orders": 37, "net_revenue": 1975.1 }
  ],
  "rowCount": 30
}

Les lignes sont triées dans l'ordre des dimensions demandées. rowCount donne le nombre de lignes renvoyées.

Exemple, les ventes par pays et par type de clientCopier le lien du titre

curl "https://app.fullmetrix.com/api/reports/tabular?dimensions=country,customer_type&metrics=orders,net_revenue,average_order_value&from=2026-07-01&to=2026-09-30" \
  -H "Authorization: Bearer fmx_VOTRE_CLE"

Exemple, les totaux d'une périodeCopier le lien du titre

Sans dimension, la réponse contient une seule ligne.

curl "https://app.fullmetrix.com/api/reports/tabular?metrics=orders,gross_sales,net_revenue,new_customers&from=2026-01-01&to=2026-09-30" \
  -H "Authorization: Bearer fmx_VOTRE_CLE"

Exemple, comparer vos boutiquesCopier le lien du titre

curl "https://app.fullmetrix.com/api/reports/tabular?dimensions=store&metrics=orders,net_revenue&from=2026-09-01&to=2026-09-30" \
  -H "Authorization: Bearer fmx_VOTRE_CLE"

Codes de réponse et erreursCopier le lien du titre

Les erreurs renvoient un objet JSON avec un champ error qui décrit le problème.

Exemple de réponse 400 pour une métrique inconnue.

{
  "error": "Dimensions ou métriques inconnues",
  "unknownDimensions": [],
  "unknownMetrics": ["revenue"]
}

En cas de code 429, la réponse contient aussi les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset. Espacez vos appels et gardez en mémoire les résultats qui ne changent pas, comme les jours passés.

Une réponse réussie peut être servie depuis un cache pendant une minute. Deux appels identiques rapprochés renvoient donc le même résultat.

L'API accepte les appels venant d'un navigateur, mais rappelez-vous que la clé ne doit jamais être exposée dans une page publique.

Questions fréquentesCopier le lien du titre