Publieke API

De publieke API van Fullmetrix geeft je verkoopcijfers terug als tabel, in JSON-formaat. Gebruik hem om een interne tool, een automatisch bijgewerkte spreadsheet, een datawarehouse of een eigen dashboard te voeden. De Looker Studio-connector draait erop.

Een API is een webadres dat een programma bevraagt in plaats van een browser. Je stuurt een verzoek waarin staat wat je wilt, bijvoorbeeld de dagelijkse omzet van vorige maand, en Fullmetrix antwoordt met de cijfers.

De API is alleen-lezen. Hij kan niets wijzigen in Fullmetrix of in je winkel.

Een API-sleutel aanmakenCopy Anchor Link

Elk verzoek moet een API-sleutel bevatten. De sleutel bepaalt van welke organisatie je de gegevens leest. Je hoeft verder niets in te stellen.

De sleutellijst toont per sleutel de Naam, het Voorvoegsel, de aanmaakdatum onder Gemaakt en Laatst gebruikt. Die laatste kolom helpt je een sleutel te herkennen die niemand meer gebruikt. Om een sleutel af te sluiten klik je op Herroepen en bevestig je. Elke integratie die hem gebruikt, stopt onmiddellijk met werken. Dit scherm wordt in detail behandeld in API-sleutels.

Maak één sleutel per tool. Moet je er een afsluiten, dan blijven de andere werken.

AuthenticerenCopy Anchor Link

Het basisadres van de API is https://app.fullmetrix.com. Elk verzoek bevat de sleutel in de header Authorization, na het woord Bearer.

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

Sleutels werken tijdens de gratis proefperiode en tijdens het abonnement. Stopt het abonnement van de organisatie, dan worden verzoeken geweigerd tot het weer doorloopt.

De beschikbare velden opvragenCopy Anchor Link

GET /api/reports/catalog geeft de dimensies en cijfers terug waar je om kunt vragen. Een dimensie is een manier om de gegevens op te splitsen, zoals datum of land. Een cijfer is een berekende waarde, zoals het aantal bestellingen.

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

{
  "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" }
  ]
}

De label-waarden worden in het Frans teruggegeven. Gebruik de id-waarden in je verzoeken.

Deze aanroep is ook een manier om te controleren of een sleutel werkt. Hij antwoordt met status 200 wanneer de sleutel geldig is.

DimensiesCopy Anchor Link

CijfersCopy Anchor Link

Bedragen staan in de valuta van je winkels en zijn afgerond op twee decimalen. De cijfers volgen je rapportinstellingen, inclusief uitgesloten statussen en aftrekposten voor de netto-omzet.

Je cijfers opvragenCopy Anchor Link

GET /api/reports/tabular geeft een tabel met rijen terug. Elke rij combineert de gevraagde dimensies met de cijfers die voor die combinatie zijn berekend.

ParametersCopy Anchor Link

De gevraagde periode kan tot twee jaar beslaan. Daarboven verkort de API hem met behoud van de einddatum, en het antwoord toont de werkelijk gebruikte datums in from en to.

De datums from en to worden gelezen in universele tijd, van middernacht tot middernacht UTC. De parameter timezone wijzigt alleen de dag die bij elke bestelling wordt getoond. Rond middernacht kunnen enkele bestellingen daardoor een dag verschillen van je Fullmetrix-rapporten.

Voorbeeld, omzet per dagCopy Anchor Link

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_YOUR_KEY"

{
  "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
}

De rijen zijn gesorteerd in de volgorde van de gevraagde dimensies. rowCount geeft het aantal teruggegeven rijen.

Voorbeeld, omzet per land en klanttypeCopy Anchor Link

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_YOUR_KEY"

Voorbeeld, totalen voor een periodeCopy Anchor Link

Zonder dimensie bevat het antwoord één rij.

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_YOUR_KEY"

Voorbeeld, je winkels vergelijkenCopy Anchor Link

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_YOUR_KEY"

Antwoordcodes en foutenCopy Anchor Link

Fouten geven een JSON-object terug met een veld error dat het probleem beschrijft.

Voorbeeld van een 400-antwoord voor een onbekend cijfer.

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

Bij een 429-code bevat het antwoord ook de headers X-RateLimit-Limit, X-RateLimit-Remaining en X-RateLimit-Reset. Spreid je aanroepen en bewaar resultaten die niet veranderen, zoals die van verstreken dagen.

Een geslaagd antwoord kan een minuut lang uit een cache komen. Twee identieke aanroepen vlak na elkaar geven dus hetzelfde resultaat.

De API accepteert aanroepen vanuit een browser, maar onthoud dat de sleutel nooit in een openbare pagina mag staan.

Veelgestelde vragenCopy Anchor Link