Öffentliche API

Die öffentliche Fullmetrix-API liefert Ihre Umsatzkennzahlen als Tabelle im JSON-Format. Nutzen Sie sie, um ein internes Tool, eine automatisierte Tabellenkalkulation, ein Data Warehouse oder ein eigenes Dashboard zu speisen. Der Looker-Studio-Connector basiert darauf.

Eine API ist eine Webadresse, die ein Programm statt eines Browsers abfragt. Sie senden eine Anfrage, die sagt, was Sie möchten, zum Beispiel den Tagesumsatz des letzten Monats, und Fullmetrix antwortet mit den Zahlen.

Die API ist schreibgeschützt. Sie kann nichts in Fullmetrix oder in Ihrem Shop ändern.

Einen API-Schlüssel erstellenCopy Anchor Link

Jede Anfrage muss einen API-Schlüssel enthalten. Der Schlüssel bestimmt die Organisation, deren Daten Sie lesen. Sonst ist nichts zu konfigurieren.

Die Schlüsselliste zeigt für jeden Schlüssel Name, Präfix, das Erstellungsdatum unter Erstellt und Zuletzt verwendet. Die letzte Spalte hilft Ihnen, einen Schlüssel zu erkennen, den niemand mehr nutzt. Um einen Schlüssel zu sperren, klicken Sie auf Widerrufen und bestätigen. Jede Integration, die ihn verwendet, funktioniert sofort nicht mehr. Dieser Bildschirm wird ausführlich unter API-Schlüssel behandelt.

Erstellen Sie einen Schlüssel pro Tool. Müssen Sie einen sperren, funktionieren die anderen weiter.

AuthentifizierenCopy Anchor Link

Die Basisadresse der API ist https://app.fullmetrix.com. Jede Anfrage trägt den Schlüssel im Header Authorization, nach dem Wort Bearer.

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

Schlüssel funktionieren während der kostenlosen Testphase und während des Abonnements. Endet das Abonnement der Organisation, werden Anfragen abgelehnt, bis es wieder läuft.

Die verfügbaren Felder auflistenCopy Anchor Link

GET /api/reports/catalog liefert die Dimensionen und Messwerte, die Sie anfordern können. Eine Dimension ist eine Art, die Daten aufzuteilen, etwa nach Datum oder Land. Ein Messwert ist eine berechnete Zahl, etwa die Anzahl der Bestellungen.

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

Die label-Werte werden auf Französisch geliefert. Verwenden Sie in Ihren Anfragen die id-Werte.

Dieser Aufruf ist auch eine Möglichkeit, zu prüfen, ob ein Schlüssel funktioniert. Er antwortet mit Status 200, wenn der Schlüssel gültig ist.

DimensionenCopy Anchor Link

MesswerteCopy Anchor Link

Beträge stehen in der Währung Ihrer Shops und sind auf zwei Dezimalstellen gerundet. Die Zahlen folgen Ihren Berichtseinstellungen, einschließlich ausgeschlossener Status und Abzüge vom Nettoumsatz.

Ihre Kennzahlen abfragenCopy Anchor Link

GET /api/reports/tabular liefert eine Tabelle mit Zeilen. Jede Zeile verbindet die angeforderten Dimensionen mit den Messwerten, die für diese Kombination berechnet wurden.

ParameterCopy Anchor Link

Der angeforderte Zeitraum kann bis zu zwei Jahre umfassen. Darüber hinaus kürzt die API ihn unter Beibehaltung des Enddatums, und die Antwort zeigt in from und to die tatsächlich verwendeten Daten.

Die Daten from und to werden in Weltzeit gelesen, von Mitternacht bis Mitternacht UTC. Der Parameter timezone ändert nur den Tag, der für jede Bestellung angezeigt wird. Um Mitternacht können daher einige Bestellungen einen Tag von Ihren Fullmetrix-Berichten abweichen.

Beispiel, Umsatz nach TagCopy 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
}

Die Zeilen sind in der Reihenfolge der angeforderten Dimensionen sortiert. rowCount gibt die Anzahl der gelieferten Zeilen an.

Beispiel, Umsatz nach Land und KundentypCopy 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"

Beispiel, Summen für einen ZeitraumCopy Anchor Link

Ohne Dimension enthält die Antwort eine einzige Zeile.

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"

Beispiel, Ihre Shops vergleichenCopy 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"

Antwortcodes und FehlerCopy Anchor Link

Fehler liefern ein JSON-Objekt mit einem Feld error, das das Problem beschreibt.

Beispielantwort 400 für einen unbekannten Messwert.

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

Bei einem Code 429 enthält die Antwort zusätzlich die Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Verteilen Sie Ihre Aufrufe und speichern Sie Ergebnisse, die sich nicht ändern, etwa vergangene Tage.

Eine erfolgreiche Antwort kann eine Minute lang aus einem Cache geliefert werden. Zwei identische Aufrufe kurz hintereinander liefern daher dasselbe Ergebnis.

Die API akzeptiert Aufrufe aus einem Browser, aber denken Sie daran, dass der Schlüssel niemals auf einer öffentlichen Seite sichtbar sein darf.

Häufig gestellte FragenCopy Anchor Link