Publiczne API

Publiczne API Fullmetrix zwraca Twoje wskaźniki sprzedaży w postaci tabeli, w formacie JSON. Użyj go do zasilenia wewnętrznego narzędzia, automatycznego arkusza, hurtowni danych lub własnego pulpitu. Działa na nim konektor Looker Studio.

API to adres internetowy, który odpytuje program zamiast przeglądarki. Wysyłasz żądanie, które mówi, czego chcesz, na przykład dzienny przychód z ostatniego miesiąca, a Fullmetrix odpowiada liczbami.

API działa tylko do odczytu. Nie może niczego zmienić we Fullmetrix ani w Twoim sklepie.

Utwórz klucz APICopy Anchor Link

Każde żądanie musi zawierać klucz API. Klucz wskazuje organizację, której dane czytasz. Nie ma nic więcej do skonfigurowania.

Lista kluczy pokazuje Nazwa każdego klucza, Przedrostek, datę utworzenia w kolumnie Utworzono oraz Ostatnio używany. Ta ostatnia kolumna pomaga wykryć klucz, którego nikt już nie używa. Aby odciąć klucz, kliknij Odwołaj, a potem potwierdź. Każda integracja, która z niego korzysta, natychmiast przestaje działać. Ten ekran opisano szczegółowo w Klucze API.

Utwórz jeden klucz na narzędzie. Jeśli musisz odciąć jeden, pozostałe nadal działają.

UwierzytelnianieCopy Anchor Link

Adres bazowy API to https://app.fullmetrix.com. Każde żądanie przekazuje klucz w nagłówku Authorization, po słowie Bearer.

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

Klucze działają w czasie bezpłatnego okresu próbnego i w czasie subskrypcji. Jeśli subskrypcja organizacji się kończy, żądania są odrzucane do czasu jej wznowienia.

Wyświetl dostępne polaCopy Anchor Link

GET /api/reports/catalog zwraca wymiary i metryki, o które możesz poprosić. Wymiar to sposób podziału danych, taki jak data lub kraj. Metryka to obliczona liczba, taka jak liczba zamówień.

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

Wartości label są zwracane po francusku. W swoich żądaniach używaj wartości id.

To wywołanie pozwala też sprawdzić, czy klucz działa. Odpowiada statusem 200, gdy klucz jest prawidłowy.

WymiaryCopy Anchor Link

MetrykiCopy Anchor Link

Kwoty są w walucie Twoich sklepów i zaokrąglone do dwóch miejsc po przecinku. Liczby uwzględniają Twoje Ustawienia raportów, w tym wykluczone statusy i odliczenia od sprzedaży netto.

Odpytuj swoje metrykiCopy Anchor Link

GET /api/reports/tabular zwraca tabelę wierszy. Każdy wiersz łączy żądane wymiary z metrykami obliczonymi dla tej kombinacji.

ParametryCopy Anchor Link

Żądany okres może obejmować do dwóch lat. Powyżej tego API skraca go, zachowując datę końcową, a odpowiedź pokazuje w from i to daty faktycznie użyte.

Daty from i to są czytane w czasie uniwersalnym, od północy do północy UTC. Parametr timezone zmienia tylko dzień pokazany przy każdym zamówieniu. Około północy kilka zamówień może więc wypaść o jeden dzień inaczej niż w Twoich raportach Fullmetrix.

Przykład, przychód według dniaCopy 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
}

Wiersze są posortowane w kolejności żądanych wymiarów. rowCount podaje liczbę zwróconych wierszy.

Przykład, sprzedaż według kraju i typu klientaCopy 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"

Przykład, sumy za okresCopy Anchor Link

Bez wymiaru odpowiedź zawiera jeden wiersz.

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"

Przykład, porównanie Twoich sklepówCopy 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"

Kody odpowiedzi i błędyCopy Anchor Link

Błędy zwracają obiekt JSON z polem error opisującym problem.

Przykładowa odpowiedź 400 dla nieznanej metryki.

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

Przy kodzie 429 odpowiedź zawiera także nagłówki X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Rozłóż wywołania w czasie i zachowuj wyniki, które się nie zmieniają, takie jak dni minione.

Poprawna odpowiedź może być serwowana z pamięci podręcznej przez jedną minutę. Dwa identyczne wywołania wykonane blisko siebie zwracają więc ten sam wynik.

API akceptuje wywołania pochodzące z przeglądarki, ale pamiętaj, że klucz nigdy nie może być widoczny na publicznej stronie.

Najczęstsze pytaniaCopy Anchor Link