API-Referenz Statistiken

Der Endpunkt statistics/ ermöglicht es Ihnen, verschiedene Statistiken Ihres Onlineshops in unserem Shop-System abzurufen. Mit der Schnittstelle ist es möglich, Statistiken zu Formularanfragen, Transaktionen und Zahlungsarten, Produktbewertungen, Bestellungen und Verkäufen und Zugriffsstatistiken abzufragen.

Unterstützte Methoden

Angabe aller unterstützten Methoden.

Befehl/Info	Endpunkte	GET	POST	PUT	DELETE
Anfragen	statistics/inquiries
Bestellungen	statistics/orders
Verkäufe	statistics/sales
Newsletter	statistics/newsletter
Produktbewertungen	statistics/productrating
Transaktionen	statistics/transactions
Zugriffe	statistics/access

Datenpersistenz bei Statistiken

Die Statistikdaten des Shop-Systems werden in drei verschiedenen Aggregationsstufen gespeichert:

• Stündliche Daten (pro Stunde)
  Diese Daten liefern die feinste Detailtiefe und ermöglichen eine präzise Analyse von kurzfristigen Ereignissen, z. B. Peaks im Bestellverhalten während einer Werbeaktion.
  → Speicherdauer: 3 Wochen
  Danach werden die Daten automatisch gelöscht, um die Datenmenge zu begrenzen.
• Tägliche Daten (pro Tag)
  Diese Aggregation eignet sich für mittel- bis langfristige Auswertungen, etwa zur Beobachtung von Wochentrends oder Kampagnenverläufen.
  → Speicherdauer: 3 Monate
• Monatliche Daten (pro Monat)
  Diese Daten sind auf langfristige Analysen ausgerichtet, z. B. zur Bewertung saisonaler Schwankungen oder jährlicher Umsatzentwicklung.
  → Speicherdauer: 3 Jahre

Diese gestaffelte Speicherung sorgt dafür, dass kurzfristig viele Details zur Verfügung stehen, während langfristig nur aggregierte Informationen erhalten bleiben.

Ressourcen

Datentabelle für Anfragen

Name	Typ	Bedeutung
contact (Bezeichnung des Formulars)	Objekt	Enthält Informationen zu dem Formular.
timestamp	String	Zeitpunkt der Aggregation (z.B. der Anfang eines Monats oder eines Tages. ISO 8601-Format, UTC)
value	Integer	Anzahl der Anfragen in dem jeweiligen Zeitintervall.

Beispiel

{
    "contact": [
        {
            "timestamp": "2025-05-16T00:00:00.000Z",
            "value": 2
        }
    ]
}

Datentabelle für Bestellungen

Name	Typ	Bedeutung
accountTypeGuest	Integer	Anzahl der Bestellungen, die von Gastkunden (ohne Kundenkonto) getätigt wurden.
accountTypeNew	Integer	Anzahl der Bestellungen, die von neu registrierten Kunden getätigt wurden.
accountTypeRegistered	Integer	Anzahl der Bestellungen von bestehenden registrierten Kunden.
amount	Float	Gesamter Umsatz der Bestellungen ohne Gutscheine und Versandkosten.
amountTotal	Float	Gesamter Umsatz inklusive aller Gutscheine und Versandkosten – der tatsächlich gezahlte Gesamtbetrag.
country	String	Ländercode (z. B. „DE“, „AT“) der Bestellung, gemäß ISO 3166-1 Alpha-2.
currency	String	Verwendete Währung der Bestellung, gemäß ISO 4217 (z. B. „EUR“, „USD“).
deviceTypeDesktop	Integer	Anzahl der Bestellungen, die über ein Desktop-Gerät ausgelöst wurden.
deviceTypeMobile	Integer	Anzahl der Bestellungen, die über ein mobiles Endgerät (Smartphone) getätigt wurden.
deviceTypeTablet	Integer	Anzahl der Bestellungen, die über ein Tablet aufgegeben wurden.
itemsCount	Integer	Gesamtanzahl der Artikel (Positionen) in den erfassten Bestellungen.
logDate	String	Zeitpunkt der Datenaggregation (z.B. der Anfang eines Monats oder eines Tages. ISO 8601-Format, UTC).
ordersCount	Integer	Gesamtanzahl der erfassten Bestellungen innerhalb des Zeitraums.
platformTypeApp	Integer	Anzahl der Bestellungen, die über eine mobile App-Plattform getätigt wurden.
platformTypeWeb	Integer	Anzahl der Bestellungen, die über die Webplattform (Browser) abgeschlossen wurden.
subshopId	String	ID des Subshops, in dem die Bestellungen erfolgten.
totalDiscount	Float	Gesamtsumme aller gewährten Rabatte über alle Bestellungen im Zeitraum.
voucherCount	Integer	Anzahl der eingesetzten Gutscheine in allen Bestellungen.
voucherValue	Float	Gesamter eingelöster Gutscheinwert über alle Bestellungen.

Beispiel

{
    "accountTypeGuest": 0,
    "accountTypeNew": 0,
    "accountTypeRegistered": 3,
    "amount": 15,
    "amountTotal": 17.9,
    "country": "DE",
    "currency": "€",
    "deviceTypeDesktop": 3,
    "deviceTypeMobile": 0,
    "deviceTypeTablet": 0,
    "itemsCount": 4,
    "logDate": "2025-05-20T14:00:00Z",
    "ordersCount": 3,
    "platformTypeApp": 0,
    "platformTypeWeb": 3,
    "subshopId": "deutsch",
    "totalDiscount": 0,
    "voucherCount": 1,
    "voucherValue": 8.95
}

Datentabelle für Verkäufe

Für GET statistics/sales

Name	Typ	Bedeutung
timestamp	String	Zeitpunkt der Datenaggregation (z.B. der Anfang eines Monats oder eines Tages. ISO 8601-Format, UTC)
value.deutsch (beliebige Subshop-ID)	Float	Umsatz im Subshop

Beispiel

{
    "timestamp": "2025-04-22T22:00:00.000Z",
    "value": {
        "deutsch": 1150.64
    }
}

Für POST statistics/sales/product

Name	Typ	Bedeutung
logDate	String	Zeitpunkt der Datenaggregation
productId	String	Eindeutige ID des Produkts, das gekauft wurde
sales	Integer	Anzahl an Verkäufen
subshopId	String	Subshop, in dem das Produkt gekauft wurde

Beispiel

{
    "logDate": "2025-05-13 00:00:00",
    "productId": "143-68071",
    "sales": 1,
    "subshopId": "deutsch"
}Datentabelle für Newsletter

Name	Typ	Bedeutung
timestamp	String	Zeitpunkt der Datenaggregation (z.B. der Anfang eines Monats oder eines Tages. ISO 8601-Format, UTC)
value	Integer	Wert, der dem Zeitpunkt zugeordnet ist

Beispiel

{
    "timestamp": "2025-04-25T00:00:00.000Z",
    "value": 3
}

Statistiken für Transaktionen und Zahlungsarten

Name	Typ	Bedeutung
country	String	Ländercode aus der Bestellung (ISO 3166-1 Alpha-2, z. B. “DE”)
id	Integer	Eindeutige ID des Statistikdatensatzes
orderData	Objekt	Enthält Bestelldaten
paymentMethod	String	Bezeichnung der verwendeten Zahlungsart
paymentStatus	Integer	Status der Zahlung. Mögliche Werte: 0 = Pending1 = Finished2 = Error3 = Redirected4 = Canceled5 = Rejected6 = CanceledByAdmin7 = Refunded8 = RefundedPartially
subshopId	String	Technische ID des betroffenen Subshops
total	Float	Gesamtumsatz für diesen Datensatz (in der jeweiligen Währung)

Beispiel

{
    "computop-hosted": {},
    "dummy": {},
    "freeFields": {
        "agb.checked": "true",
        "agb.merchantText": "agb text here",
        "comment.text": ""
    },
    "general": {
        "dateTime": "2025-04-23T08:26:14Z",
        "orderId": "531",
        "sessionId": "012bb5b99f69e976d4ae297ef1dcfdc59790d0ecb3756126b6f4fd08663c5790",
        "shopId": "test-mgoepfrich",
        "shopLanguage": "Deutsch",
        "subshopId": "deutsch",
        "testMode": false
    },
    "order": {
        "currencyIso": "EUR",
        "currencySymbol": "€",
        "defaultTaxRate": "0.1900000",
        "delivererId": "dhl",
        "delivererOrderText": "DHL",
        "deliveryCost": "0.00",
        "deliveryTaxRate": "0.1900000",
        "paymentId": "bill",
        "paymentOrderText": "Rechnung",
        "priceType": "gross",
        "referer": "https://test-mgoepfrich.shop.websale.net/",
        "subreferer": "",
        "subtotal": "1055.67",
        "tax": "168.55",
        "total": "1055.67",
        "totalCommission": "0.00",
        "totalDiscount": "0.00",
        "totalVoucher": "0.00",
        "totalWeight": 0
    },
    "orderList": {
        "item": [
            {
                "basketId": "a954f8529d0a00df2f84",
                "discount": "0.00",
                "extraFields": {},
                "isAutoBasket": false,
                "isChangeable": true,
                "isRemovable": true,
                "isVisible": true,
                "itemNumber": "BD-0001",
                "name": "Damen NOOS High-Waist Curvy Skinny Jeans",
                "orgPrice": "0.00",
                "price": "31.99",
                "productId": "100-69659",
                "quantity": "33.00",
                "singleTotal": "31.99",
                "taxId": "19",
                "taxRate": "0.1900000",
                "total": "1055.67",
                "variantId": "2",
                "variantSelection": [
                    {
                        "attributeId": "Größe",
                        "optionId": "M"
                    }
                ],
                "weight": 0
            }
        ]
    },
    "paypal-checkout": {
        "executePayPalResponse": "",
        "expressCheckout": "false",
        "orderID": "",
        "paymentAction": "CAPTURE",
        "paymentID": "",
        "paymentMode": "PayPal",
        "paypalStatus": ""
    },
    "paypal-plus": {},
    "shippingAddress": null,
    "vouchers": null
}

Methoden für Anfragen

GET statistics/inquiries

Diese Methode liefert statistische Auswertungen zu den im Shop genutzten Anfragefunktionen (z. B. Kontaktformular, Rückrufservice, Reklamation etc.). Die Daten werden für jeden Subshop separat zurückgegeben und können stunden-, tage- oder monatsweise aggregiert werden.

Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Um die Daten abrufen zu können, müssen entsprechende Berechtigungen zum Lesen von Statistiken vorhanden sein.

Beispiel

Im gezeigten Beispiel werden die Anzahl der Anfragen im Zeitraum vom 29.02.2024 bis zum 28.02.2025 monatsweise ausgewertet - für die Subshops deutsch und english.

https://www.<ihr-shop>.de/admin/api/v1/statistics/inquiries/?from=2024-02-29T23:00:00.066Z&to=2025-02-28T22:59:59.066Z&aggregation=months&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

{
    "deutsch": {
        "contact": [
            {
                "timestamp": "2024-10-01T00:38:42.000Z",
                "value": 4
            }
        ]
    }
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/inquiries/duration

Es werden die Bearbeitungszeiten der Anfragen geliefert. value gibt an, wie viele Tage für die Bearbeitung benötigt wurden. count gibt an, wie oft der Wert vorkommt.

Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Um die Daten abrufen zu können, müssen entsprechende Berechtigungen zum Lesen von Statistiken vorhanden sein.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/inquiries/duration/?from=2024-02-29T23:00:00.353Z&to=2025-02-28T22:59:59.353Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

{
    "deutsch": {
        "contact": [
            {
                "count": 2,
                "value": 3
            }
        ],
        "productQuestion": [
            {
                "count": 1,
                "value": 6
            },
            {
                "count": 1,
                "value": 13
            }
        ]
    }
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.

Methoden für Bestellstatistiken

POST statistics/orders/hours

Dieser Endpunkt liefert stundenweise aggregierte Bestellstatistiken für den angegebenen Zeitraum.

Im Request-Body können optional Subshops angegeben werden, um die Auswertung gezielt einzugrenzen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/orders/hours?from=2025-04-30T22:00:00.000Z&to=2025-05-13T22:00:00.000Z

Request Body

{
    "subshops": [
        "deutsch",
        "englisch"
    ]
}

Antwort

{
    "items": [
        {
            "accountTypeGuest": 0,
            "accountTypeNew": 0,
            "accountTypeRegistered": 1,
            "amount": 5,
            "amountTotal": 8.95,
            "country": "DE",
            "currency": "€",
            "deviceTypeDesktop": 1,
            "deviceTypeMobile": 0,
            "deviceTypeTablet": 0,
            "feeTotalOrder": 0.08,
            "itemsCount": 1,
            "logDate": "2025-05-20T14:00:00Z",
            "ordersCount": 1,
            "platformTypeApp": 0,
            "platformTypeWeb": 1,
            "subshopId": "deutsch",
            "totalDiscount": 0,
            "voucherCount": 0,
            "voucherValue": 0
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

POST statistics/orders/days

Dieser Endpunkt liefert tageweise aggregierte Bestellstatistiken für den angegebenen Zeitraum.

Im Request-Body können optional Subshops angegeben werden, um die Auswertung gezielt einzugrenzen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/orders/days?from=2025-04-30T22:00:00.000Z&to=2025-05-13T22:00:00.000Z

Request Body

{
    "subshops": [
        "deutsch",
        "englisch"
    ]
}

Antwort

{
    "items": [
        {
            "accountTypeGuest": 0,
            "accountTypeNew": 0,
            "accountTypeRegistered": 2,
            "amount": 66.98,
            "amountTotal": 66.98,
            "country": "DE",
            "currency": "€",
            "deviceTypeDesktop": 2,
            "deviceTypeMobile": 0,
            "deviceTypeTablet": 0,
            "feeTotalOrder": 6.98,
            "itemsCount": 2,
            "logDate": "2025-05-16T00:00:00Z",
            "ordersCount": 2,
            "platformTypeApp": 0,
            "platformTypeWeb": 2,
            "subshopId": "deutsch",
            "totalDiscount": 0,
            "voucherCount": 0,
            "voucherValue": 0
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

POST statistics/orders/months

Dieser Endpunkt liefert monatsweise aggregierte Bestellstatistiken für den angegebenen Zeitraum.

Im Request-Body können optional Subshops angegeben werden, um die Auswertung gezielt einzugrenzen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/orders/months?from=2025-04-30T22:00:00.000Z&to=2025-05-13T22:00:00.000Z

Request Body

{
    "subshops": [
        "deutsch",
        "englisch"
    ]
}

Antwort

{
    "items": [
        {
            "accountTypeGuest": 24,
            "accountTypeNew": 0,
            "accountTypeRegistered": 146,
            "amount": 23573.4,
            "amountTotal": 22705.61,
            "country": "DE",
            "currency": "€",
            "deviceTypeDesktop": 170,
            "deviceTypeMobile": 0,
            "deviceTypeTablet": 0,
            "feeTotalOrder": 235.73,
            "itemsCount": 311,
            "logDate": "2025-05-01T00:00:00Z",
            "ordersCount": 170,
            "platformTypeApp": 0,
            "platformTypeWeb": 170,
            "subshopId": "deutsch",
            "totalDiscount": 0,
            "voucherCount": 11,
            "voucherValue": 887.54
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

Methoden für Verkäufe

GET statistics/sales

Dieser Endpunkt liefert die Umsätze im angegebenen Zeitraum, gruppiert nach Subshop und einem wählbaren Aggregationsintervall.

Die Aggregation kann in Stunden, Tagen oder Monaten erfolgen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

Im gezeigten Beispiel wird der Umsatz im Zeitraum vom 22.04.2025 bis zum 28.04.2025 tagesweise aggregiert.

https://www.<ihr-shop>.de/admin/api/v1/statistics/sales?from=2025-04-22T22:00:00.000Z&to=2025-04-28T22:00:00.000Z&aggregation=days

Antwort

[
    {
        "timestamp": "2025-04-22T22:00:00.000Z",
        "value": {
            "deutsch": 1150.64
        }
    },
    {
        "timestamp": "2025-04-23T22:00:00.000Z",
        "value": {}
    },
    {
        "timestamp": "2025-04-24T22:00:00.000Z",
        "value": {
            "deutsch": 323.91
        }
    },
    {
        "timestamp": "2025-04-25T22:00:00.000Z",
        "value": {}
    },
    {
        "timestamp": "2025-04-26T22:00:00.000Z",
        "value": {}
    },
    {
        "timestamp": "2025-04-27T22:00:00.000Z",
        "value": {
            "deutsch": 183.92
        }
    }
]

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/soldProducts

Dieser Endpunkt liefert Verkaufszahlen im angegebenen Zeitraum, gruppiert nach Subshop und einem wählbaren Aggregationsintervall.

Die Aggregation kann in Stunden, Tagen oder Monaten erfolgen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

Im gezeigten Beispiel werden die Verkaufszahlen im Zeitraum vom 02.07.2025 bis zum 30.09.2025 monatsweise aggregiert.

https://www.<ihr-shop>.de/admin/api/v1/statistics/soldProducts?from=2025-07-02T22:00:00.612Z&to=2025-09-30T21:59:59.612Z&aggregation=months

Antwort

[
    {
        "timestamp": "2025-07-02T00:00:00.000Z",
        "value": {
            "deutsch": 9
        }
    },
    {
        "timestamp": "2025-08-02T00:00:00.000Z",
        "value": {
            "deutsch": 15
        }
    },
    {
        "timestamp": "2025-09-02T00:00:00.000Z",
        "value": {}
    }
]

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

POST statistics/sales/product

Dieser Endpunkt liefert die Verkaufszahlen ausgewählter Produkte im angegebenen Zeitraum, gruppiert nach Datum und Subshop.

Die Abfrage erfolgt durch Übergabe einer Liste von Produkt-IDs im Request Body. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/sales/product?from=2025-04-30T22:00:00.000Z&to=2025-05-13T22:00:00.000Z

Request Body

{
    "productIds": [
        "100-41232",
        "143-68071"
    ]
}

Antwort

{
    "items": [
        {
            "logDate": "2025-05-13 00:00:00",
            "productId": "143-68071",
            "sales": 1,
            "subshopId": "deutsch"
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

Methoden für Newsletter-Statistiken

GET statistics/newsletter/subscribed

Dieser Endpunkt liefert die Anzahl neuer Newsletter-Abonnenten im angegebenen Zeitraum, gruppiert nach dem übergebenen Aggregationsintervall.

Die Auswertung kann über den Filter subshopId auf einzelne Subshops eingeschränkt werden. Ohne den Parameter filter_eq[subshopId] werden alle Subshops berücksichtigt. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/newsletter/subscribed?from=2024-05-31T22:00:00.462Z&to=2025-05-31T21:59:59.462Z&aggregation=months&filter_eq[subshopId]=deutsch

Antwort

[
    {
        "timestamp": "2025-04-25T00:00:00.000Z",
        "value": 3
    },
    {
        "timestamp": "2025-04-29T00:00:00.000Z",
        "value": 4
    }
]

Filterfelder

subshopId

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Der Parameter aggregation fehlt.
400 Bad Request	”invalidFormat”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
400 Bad Request	”invalidFormat”

GET statistics/newsletter/unsubscribed

Dieser Endpunkt liefert die Anzahl der Newsletter-Abmeldungen im angegebenen Zeitraum, gruppiert nach dem angegebenen Aggregationsintervall.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt werden. Ohne den Parameter filter_eq[subshopId] werden alle Subshops berücksichtigt. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/newsletter/unsubscribed?from=2025-04-12T22:00:00.926Z&to=2025-05-12T21:59:59.926Z&aggregation=days&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort

[
    {
        "timestamp": "2025-04-25T00:00:00.000Z",
        "value": 1
    }
]

Filterfelder

subshopId

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Der Parameter aggregation fehlt.
400 Bad Request	”invalidFormat”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
400 Bad Request	”invalidFormat”

Methoden für Statistiken der Produktbewertung

POST statistics/productrating

Dieser Endpunkt liefert alle erfassten Produktbewertungen im angegebenen Zeitraum, inklusive Bewertungstexten, Punkten, Genehmigungsstatus und weiteren Metadaten.

Die Ergebnisse enthalten neben der Bewertung auch Informationen wie Subshop, Produkt-ID, Bewertungsersteller und eventuelle Händlerkommentare. Wenn das Feld type die Werte 1 (MostRated) oder 2 (BestRated) enthält, können auch die Durchschnittswerte und die Anzahl der Bewertungen vorkommen.

Es ist möglich, nur bestimmte Subshops und bei type=0 nur bestimmte Produkte zu berücksichtigen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/productrating?from=2024-05-14T22:00:00.000Z&to=2025-05-15T10:49:09.230Z

Request Body

{
    "subshops": [
        "deutsch",
        "englisch"
    ],
    "limit": 5,
    "type": 2
}

Antwort

{
    "items": [
        {
            "accountId": "37",
            "accountType": 2,
            "anonymous": false,
            "answeredAt": "2025-04-24 12:25:41",
            "approval": true,
            "avgRating": 4.5,
            "categoryId": "",
            "createdAt": "2025-04-23 12:52:14",
            "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit. Animi illum odit accusantium, ipsum pariatur laborum quos dolor nulla error deserunt placeat minima tempore vitae harum alias necessitatibus facere quae quidem!",
            "disapprovalReason": "",
            "id": 1,
            "merchantComment": "Das ist ein Test Kommentar.",
            "orderId": "536",
            "points": 4,
            "productId": "101-41470",
            "productType": "standard",
            "subject": "Lorem ipsum dolor sit amet consectetur",
            "subshopId": "deutsch"
        },
        {
            "accountId": "39",
            "accountType": 2,
            "anonymous": false,
            "answeredAt": "",
            "approval": false,
            "avgRating": 4.7,
            "categoryId": "",
            "createdAt": "2025-04-23 13:13:49",
            "description": "cool",
            "disapprovalReason": "",
            "id": 2,
            "merchantComment": "",
            "orderId": "553",
            "points": 5,
            "productId": "101-41470",
            "productType": "standard",
            "subject": "oh yea",
            "subshopId": "deutsch"
        },
        {
            "accountId": "37",
            "accountType": 2,
            "anonymous": true,
            "answeredAt": "2025-04-29 08:31:00",
            "approval": false,
            "avgRating": 3,
            "categoryId": "",
            "createdAt": "2025-04-24 12:39:19",
            "description": "asdfasdf Test 1233",
            "disapprovalReason": "Falsche angabe.",
            "id": 5,
            "merchantComment": "",
            "orderId": "557",
            "points": 3,
            "productId": "103-91837",
            "productType": "standard",
            "subject": "Verbesserung",
            "subshopId": "deutsch"
        },
        ...
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte. Statistiken konnten nicht geladen werden.

POST statistics/productrating/average

Dieser Endpunkt liefert den durchschnittlichen Bewertungswert aller erfassten Produktbewertungen im angegebenen Zeitraum.

Die Auswertung umfasst alle Bewertungen über sämtliche Subshops hinweg. Wenn das Feld "subshops" übergeben wird, werden nur die aufgelisteten Subshops berücksichtigt. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/productrating/average?from=2024-05-14T22:00:00.000Z&to=2025-05-15T10:55:44.323Z

Request Body

{
    "subshops": [
        "deutsch",
        "englisch"
    ]
}

Antwort

{
    "data": "4.0"
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte. Statistiken konnten nicht geladen werden.

POST statistics/productrating/count

Dieser Endpunkt liefert die Gesamtanzahl aller erfassten Produktbewertungen im angegebenen Zeitraum.

Die Zählung umfasst alle Bewertungen unabhängig von deren Freigabestatus. Wenn das Feld "subshops" übergeben wird, werden nur die aufgelisteten Subshops berücksichtigt. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/productrating/count?from=2024-05-14T22:00:00.000Z&to=2025-05-15T10:55:44.323Z

Request Body

{
    "subshops": [
        "deutsch",
        "englisch"
    ]
}

Antwort

{
    "data": 4
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte. Statistiken konnten nicht geladen werden.

POST statistics/productrating/averagecount

Dieser Endpunkt liefert den durchschnittlichen Bewertungswert pro Produkt im angegebenen Zeitraum.

Die Auswertung umfasst alle Bewertungen über sämtliche Subshops hinweg. Wenn das Feld "subshops" übergeben wird, werden nur die aufgelisteten Subshops berücksichtigt. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/productrating/averagecount?from=2024-05-14T22:00:00.000Z&to=2025-05-15T10:55:44.323Z

Request Body

{
    "subshops": [
        "deutsch",
        "englisch"
    ]
}

Antwort

{
    "data": "1.3333"
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte. Statistiken konnten nicht geladen werden.

Methoden für Transaktionen & Zahlungsarten

GET statistics/transactions

Dieser Endpunkt liefert eine Liste von Transaktionen mit detaillierten Bestell- und Zahlungsinformationen für den angegebenen Zeitraum, gruppiert nach dem gewählten Aggregationsintervall.

Die Auswertung kann über den Filter subshopId auf einzelne Subshops eingegrenzt werden. Wenn gar keine Subshop-ID angegeben wird, werden keine Daten geliefert. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/transactions?from=2024-02-29T23:00:00.635Z&to=2025-02-28T22:59:59.635Z&aggregation=months&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

{
    "items": [
        {
            "country": "Deutschland",
            "createdAt": "2024-10-10T12:00:00.000Z",
            "orderData": {
              ...
            },
            "paymentMethod": "PayPal Checkout (PayLater)",
            "paymentStatus": 4,
            "subshopId": "deutsch",
            "total": 11
        },
        {
            "country": "Deutschland",
            "createdAt": "2024-10-10T12:00:00.000Z",
            "orderData": {
                ...
            },
            "paymentMethod": "Rechnung",
            "paymentStatus": 1,
            "subshopId": "deutsch",
            "total": 11
        },
        ...
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/transactions/tableData

Dieser Endpunkt liefert eine tabellarische Übersicht der Umsätze, gruppiert nach Zahlungsart und Land, für den angegebenen Zeitraum.

Die Daten sind nach Land sortiert und können zusätzlich über die Filter subshopId und country eingeschränkt werden. Wenn gar keine Subshop-ID oder gar kein Land angegeben wird, werden keine Daten geliefert. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/transactions/tableData?size=100&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english&filter_eq[country]=Deutschland&from=2025-05-09T22:00:00.681Z&to=2025-05-16T21:59:59.681Z&aggregation=days

Antwort

{
    "items": [
        {
            "country": "Deutschland",
            "paymentMethod": "PayPal Checkout",
            "total": 8.949999809265137
        },
        {
            "country": "Deutschland",
            "paymentMethod": "Sichere Zahlungsart",
            "total": 8.949999809265137
        }
    ]
}

Filterfelder

subshopID, country

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/transactions/countries

Dieser Endpunkt liefert eine Liste aller Länder, aus denen im Shop Bestellungen getätigt wurden.

Die zurückgegebenen Länderwerte können zur Filterung in anderen Transaktionsendpunkten verwendet werden.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/transactions/countries

Antwort

{
    "items": ["Deutschland"]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/transactions/methods

Dieser Endpunkt liefert eine Liste aller im Shop verwendeten Zahlungsarten, die in den Transaktionsdaten erfasst wurden.

Die aufgeführten Zahlungsarten können zur Filterung in weiteren statistischen Auswertungen genutzt werden.

Für die Nutzung sind Leseberechtigungen zum Lesen von Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/transactions/methods

Antwort

{
    "items": [
        "Min Rechnung",
        "PayPal Checkout",
        "PayPal Checkout (PayLater)",
        "Rechnung",
        "Sichere Zahlungsart",
        "Vorauskasse"
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

Methoden für Zugriffsstatistiken

GET statistics/access/currentVisitors

Dieser Endpunkt liefert die aktuelle Anzahl an Besuchern sowie die Vergleichszahl zum gleichen Zeitpunkt am Vortag.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt oder subshopübergreifend erfolgen. Ohne den Parameter filter_eq[subshopId] werden berücksichtigt.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/currentVisitors

Antwort

{
    "numVisitors": 161,
    "numVisitorsYesterday": 50
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.

GET statistics/access/visitors

Dieser Endpunkt liefert die Anzahl der Besucher (ausschließlich menschlicher Nutzer) im angegebenen Zeitraum, gruppiert nach einem Aggregationsintervall.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/visitors?from=2025-03-31T22:00:00.000Z&to=2025-07-31T21:59:59.000Z&aggregation=month&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

{
    "items": [
        {
            "count": 0,
            "key": 1740787200000,
            "key_as_string": "2025-03-01T00:00:00.000Z",
            "uniqueVisitors": {
                "value": 0
            }
        },
        {
            "count": 3212,
            "key": 1743465600000,
            "key_as_string": "2025-04-01T00:00:00.000Z",
            "uniqueVisitors": {
                "value": 1
            }
        },
        {
            "count": 9777,
            "key": 1746057600000,
            "key_as_string": "2025-05-01T00:00:00.000Z",
            "uniqueVisitors": {
                "value": 1
            }
        },
        {
            "count": 1346,
            "key": 1748736000000,
            "key_as_string": "2025-06-01T00:00:00.000Z",
            "uniqueVisitors": {
                "value": 1
            }
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/robots

Dieser Endpunkt liefert die Anzahl der Zugriffe durch Suchmaschinen-Bots im angegebenen Zeitraum.

Die Daten ermöglichen die Auswertung von Bot-Traffic auf dem Shop. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/robots?from=2025-05-19T12:58:15.873Z&to=2025-05-31T21:59:59.999Z

Antwort

5623

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/all

Dieser Endpunkt liefert die Gesamtanzahl der Besucher im angegebenen Zeitraum.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingegrenzt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/all?from=2025-05-08T22:00:00.795Z&to=2025-05-15T21:59:59.795Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort

171

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/httpCodes

Dieser Endpunkt liefert eine Übersicht, wie häufig bestimmte HTTP-Statuscodes im angegebenen Zeitraum aufgetreten sind, inklusive der zugehörigen Pfade.

Die Daten ermöglichen eine gezielte Analyse der Systemantworten (z. B. 200, 301, 500) auf unterschiedliche Zugriffsanfragen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/httpCodes?from=2025-05-01T07:51:51.600Z&to=2025-05-15T07:51:51.600Z

Antwort

{
    "items": [
        {
            "count": 125742,
            "key": "200",
            "subStats": [
                {
                    "count": 86880,
                    "key": "/"
                },
                {
                    "count": 364,
                    "key": "/?wsvc=View&view=basket.htm"
                },
                {
                    "count": 308,
                    "key": "/?wsvc=View&view=error.htm"
                },
                {
                    "count": 98,
                    "key": "/?wsvc=Product&productId=140-23474"
                },
                {
                    "count": 97,
                    "key": "/checkout?step=3&payDelivChange=true"
                },
                ...
            ]
        },
        {
            "count": 536,
            "key": "302",
            "subStats": [
                {
                    "count": 119,
                    "key": "/?wsvc=View&view=basket.htm"
                },
                {
                    "count": 70,
                    "key": "/checkout?step=3&payDelivChange=true"
                },
                {
                    "count": 63,
                    "key": "/"
                },
                {
                    "count": 22,
                    "key": "/Bekleidung/Damen_NOOS_High-Waist_Curvy_Skinny_Jeans?varid=2"
                },
                {
                    "count": 22,
                    "key": "/checkout?step=2"
                },
                ...
            ]
        },
        {
            "count": 299,
            "key": "301",
            "subStats": [
                {
                    "count": 134,
                    "key": "/robots.txt"
                },
                {
                    "count": 23,
                    "key": "/favicon.ico"
                },
                {
                    "count": 9,
                    "key": "/(Null)"
                },
                {
                    "count": 6,
                    "key": "/checkout?step=3&payDelivChange=true"
                },
                {
                    "count": 3,
                    "key": "/.env"
                },
                {
                    "count": 3,
                    "key": "/_profiler/phpinfo"
                },
                {
                    "count": 2,
                    "key": "/?wsvc=View&view=account%2femailVerify.htm"
                },
                ...
            ]
        },
        {
            "count": 2,
            "key": "500",
            "subStats": [
                {
                    "count": 2,
                    "key": "/?wsvc=View&view=account%2fwatchlist.htm"
                }
            ]
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/os

Dieser Endpunkt liefert eine Übersicht darüber, wie häufig bestimmte Betriebssysteme im angegebenen Zeitraum für Zugriffe auf den Shop verwendet wurden.

Die Auswertung kann über die Filter subshopId und device gezielt auf einzelne Subshops und Gerätetypen eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/os?from=2025-05-01T07:51:51.598Z&to=2025-05-15T07:51:51.598Z&filter_eq[subshopId]=deutsch

Antwort:

    "items": [
        {
            "count": 86565,
            "key": "Other"
        },
        {
            "count": 36141,
            "key": "Android"
        },
        {
            "count": 3675,
            "key": "Windows"
        },
        {
            "count": 193,
            "key": "Linux"
        },
        {
            "count": 3,
            "key": "Mac OS X"
        },
        {
            "count": 2,
            "key": "iOS"
        }
    ]
}

Filterfelder

subshopID, device

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/browser

Dieser Endpunkt liefert eine Auswertung darüber, wie häufig bestimmte Browser – gruppiert nach Versionen – im angegebenen Zeitraum genutzt wurden.

Die Analyse kann über die Filter subshopId und device auf bestimmte Subshops und Gerätetypen eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/browser?from=2025-05-01T07:51:51.599Z&to=2025-05-15T07:51:51.599Z&filter_eq[subshopId]=deutsch

Antwort

{
    "items": [
        {
            "count": 86404,
            "group by major-version": {
                "buckets": [
                    {
                        "count": 86404,
                        "key": "1"
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            },
            "key": "Go-http-client"
        },
        {
            "count": 36064,
            "group by major-version": {
                "buckets": [
                    {
                        "count": 36064,
                        "key": "2"
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            },
            "key": "Googlebot"
        },
        {
            "count": 3363,
            "group by major-version": {
                "buckets": [
                    {
                        "count": 2566,
                        "key": "136"
                    },
                    {
                        "count": 755,
                        "key": "135"
                    },
                    {
                        "count": 17,
                        "key": "81"
                    },
                    ...
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            },
            "key": "Chrome"
        },
        {
            "count": 372,
            "group by major-version": {
                "buckets": [
                    {
                        "count": 332,
                        "key": "138"
                    },
                    {
                        "count": 29,
                        "key": "137"
                    },
                    {
                        "count": 8,
                        "key": "120"
                    },
                    {
                        "count": 3,
                        "key": "136"
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            },
            "key": "Firefox"
        },
        ...
    ]
}

Filterfelder

subshopID, device

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/action

Dieser Endpunkt liefert eine Übersicht darüber, wie häufig bestimmte Shop-Aktionen im angegebenen Zeitraum durchgeführt wurden.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/action?from=2025-04-15T07:51:51.601Z&to=2025-05-15T07:51:51.601Z&filter_eq[subshopId]=deutsch

Antwort

{
    "items": [
        {
            "count": 87563,
            "key": "StartpageShow"
        },
        {
            "count": 37134,
            "key": "ProductShow"
        },
        {
            "count": 3824,
            "key": "ViewShow"
        },
        {
            "count": 1106,
            "key": "CategoryShow"
        },
        {
            "count": 259,
            "key": "BasketItemAdd"
        },
        {
            "count": 160,
            "key": "InquirySend"
        },
        {
            "count": 138,
            "key": "SearchShow"
        },
        {
            "count": 113,
            "key": "CheckPasswordStrength"
        },
        {
            "count": 109,
            "key": "WatchListItemAdd"
        },
        {
            "count": 106,
            "key": "Login"
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/importantActionsRate

Dieser Endpunkt liefert Informationen darüber, in wie vielen Sitzungen wichtige Aktionen durchgeführt wurden. Dazu gehören:

• Bestellung
• Gutscheineinlösung
• Registrierung
• Adressaktualisierung
• Anfragestellung
• Produktzugabe zum Warenkorb

Wird der Parameter aggregation gesetzt (hour, day oder month; ohne “s”), erfolgt die Ausgabe gruppiert nach Zeit. Zusätzlich kann über den Filter subshopId eine Einschränkung auf bestimmte Subshops erfolgen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Um bei aggregierten Daten die Rate zu ermitteln, soll zuerst die Summe von totalSessionCount.value für jeden Subshop berechnet werden. Dann sollen die Werte totalSessionCount.value durch die Summe geteilt werden.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/importantActionsRate?from=2025-04-20T22:00:00.770Z&to=2025-05-20T21:59:59.770Z&aggregation=day&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort (aggregierte Daten)

{
    "items": [
        {
            "count": 16,
            "key": 1747008000000,
            "key_as_string": "2025-05-12T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 16,
                        "key": "deutsch",
                        "totalSessionCount": {
                            "value": 16
                        }
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        {
            "count": 1,
            "key": 1747094400000,
            "key_as_string": "2025-05-13T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 1,
                        "key": "deutsch",
                        "totalSessionCount": {
                            "value": 1
                        }
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        {
            "count": 3,
            "key": 1747180800000,
            "key_as_string": "2025-05-14T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 3,
                        "key": "deutsch",
                        "totalSessionCount": {
                            "value": 3
                        }
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        {
            "count": 11,
            "key": 1747267200000,
            "key_as_string": "2025-05-15T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 11,
                        "key": "deutsch",
                        "totalSessionCount": {
                            "value": 11
                        }
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        }
    ]
}

Antwort (nicht aggregierte Daten)

{
    "totalSessionCount": 58,
    "convertedSessionCount": 17,
    "convertedSessionRatio": 0.29310344827586204
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/products

Dieser Endpunkt liefert eine Liste der meistbesuchten Produkte im angegebenen Zeitraum, inklusive Zugriffszahlen und Produktnamen.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/products?from=2025-05-08T22:00:00.395Z&to=2025-05-15T21:59:59.395Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort

{
    "items": [
        {
            "count": 108,
            "key": "144-11648",
            "max_score": 6.618824,
            "name": "Flyer Option 2"
        },
        {
            "count": 95,
            "key": "140-23474",
            "max_score": 6.618824,
            "name": "Flyer Option 1"
        },
        {
            "count": 50,
            "key": "163-44034",
            "max_score": 6.618824,
            "name": "Kapuzenjacke"
        },
        {
            "count": 16,
            "key": "153-83280",
            "max_score": 6.618824,
            "name": "Straight Fit Jeans"
        },
        ...
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/categories

Dieser Endpunkt liefert eine Liste der meistbesuchten Kategorien im angegebenen Zeitraum, inklusive Zugriffszahlen und Kategorienamen.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/categories?from=2025-05-14T12:00:00.167Z&to=2025-05-15T11:59:59.167Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort

{
    "items": [
        {
            "count": 73,
            "key": "104-40827",
            "max_score": 6.9967184,
            "name": "Sale"
        },
        {
            "count": 49,
            "key": "101-64607",
            "max_score": 6.9967184,
            "name": "Elektronik & Computer"
        },
        {
            "count": 39,
            "key": "100-14213",
            "max_score": 6.9967184,
            "name": "Bekleidung"
        },
        {
            "count": 35,
            "key": "102-42333",
            "max_score": 6.9967184,
            "name": "Drucksachen"
        },
        {
            "count": 32,
            "key": "106-25201",
            "max_score": 6.9967184,
            "name": "Tiernahrung"
        },
        {
            "count": 25,
            "key": "105-19647",
            "max_score": 6.9967184,
            "name": "Personalisierte Artikel"
        },
        ...
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/devices

Dieser Endpunkt liefert eine Übersicht, wie häufig bestimmte Gerätetypen im angegebenen Zeitraum für Zugriffe auf den Shop verwendet wurden.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/devices?from=2025-05-08T22:00:00.381Z&to=2025-05-15T21:59:59.381Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort

{
    "items": [
        {
            "count": 61747,
            "key": "Spider"
        },
        {
            "count": 1490,
            "key": "Other"
        },
        {
            "count": 96,
            "key": "Nexus 5"
        },
        {
            "count": 23,
            "key": "Nexus 5X"
        },
        {
            "count": 3,
            "key": "Mac"
        },
        {
            "count": 2,
            "key": "iPhone"
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/devicesList

Dieser Endpunkt liefert eine Liste aller erfassten Geräte, mit denen auf den Shop zugegriffen wurde, einschließlich der jeweiligen Zugriffszahlen.

Die Daten ermöglichen eine Analyse der eingesetzten Endgeräte bei Shop-Besuchen. Im Gegensatz zu GET statistics/access/devices muss der Zeitraum nicht angegeben werden.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/devicesList

Antwort

{
    "items": [
        {
            "count": 122513,
            "key": "Spider"
        },
        {
            "count": 10107,
            "key": "Other"
        },
        {
            "count": 137,
            "key": "Nexus 5"
        },
        {
            "count": 102,
            "key": "Nexus 5X"
        },
        {
            "count": 65,
            "key": "Mac"
        },
        {
            "count": 11,
            "key": "Samsung SM-J111F"
        },
        {
            "count": 10,
            "key": "K"
        },
        {
            "count": 5,
            "key": "iPhone"
        },
        {
            "count": 4,
            "key": "M2004J15SC"
        },
        {
            "count": 3,
            "key": "Samsung SM-G930V"
        },
        {
            "count": 3,
            "key": "Samsung SM-G965U"
        },
        {
            "count": 2,
            "key": "Samsung SM-G965F"
        },
        {
            "count": 1,
            "key": "Generic Feature Phone"
        },
        {
            "count": 1,
            "key": "HTC One M9"
        },
        {
            "count": 1,
            "key": "Huawei Crawler"
        },
        {
            "count": 1,
            "key": "Nokia E7-00"
        },
        {
            "count": 1,
            "key": "SM-T580"
        },
        {
            "count": 1,
            "key": "XiaoMi Mi MIX 2S"
        },
        {
            "count": 1,
            "key": "XiaoMi Redmi 6"
        },
        {
            "count": 1,
            "key": "XiaoMi Redmi Note 4"
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/clicksCountPerSession

Dieser Endpunkt liefert die durchschnittliche Anzahl an Klicks pro Besuch (Sitzung) im angegebenen Zeitraum, exakt berechnet ohne Rundung.

Die Auswertung kann über den Filter subshopId auf einzelne Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/clicksCountPerSession?from=2025-05-08T22:00:00.387Z&to=2025-05-15T21:59:59.387Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

15.444444444444445

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/clicksCountPerUser

Dieser Endpunkt liefert die durchschnittliche Anzahl an Klicks pro Besucher im angegebenen Zeitraum.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingegrenzt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/clicksCountPerUser?from=2025-04-15T22:00:00.942Z&to=2025-05-15T21:59:59.942Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

{
    "averageClicksCount": 8
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/trafficPeaks

Dieser Endpunkt liefert die Zeitpunkte mit den höchsten gleichzeitigen Nutzerzahlen (Spitzenverkehr) innerhalb eines definierten Zeitraums, getrennt nach Subshops.

Die Aggregation erfolgt über hours, days oder months und ist erforderlich. Zusätzlich kann über den Filter subshopId gezielt auf einzelne Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/trafficPeaks?from=2025-05-13T22:00:00.394Z&to=2025-05-20T21:59:59.394Z&aggregation=days&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

{
    "items": [
        {
            "maxUsers": 2,
            "subshopId": "deutsch",
            "timestamp": "2024-10-25T17:02:34.000Z"
        },
        {
            "maxUsers": 2,
            "subshopId": "english",
            "timestamp": "2024-10-25T17:02:34.000Z"
        },
        {
            "maxUsers": 2,
            "subshopId": "deutsch",
            "timestamp": "2024-12-11T14:11:07.000Z"
        },
        {
            "maxUsers": 0,
            "subshopId": "english",
            "timestamp": "2024-12-11T14:11:07.000Z"
        },
        {
            "maxUsers": 0,
            "subshopId": "deutsch",
            "timestamp": "2025-01-30T18:35:06.000Z"
        },
        {
            "maxUsers": 0,
            "subshopId": "english",
            "timestamp": "2025-01-30T18:35:06.000Z"
        },
        {
            "maxUsers": 2,
            "subshopId": "deutsch",
            "timestamp": "2025-03-02T05:04:12.000Z"
        },
        {
            "maxUsers": 0,
            "subshopId": "english",
            "timestamp": "2025-03-02T05:04:12.000Z"
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/sessionsWithoutRouting

Dieser Endpunkt liefert die Anzahl der Sitzungen ohne weitere Navigation im Shop (Absprünge) für einen bestimmten Zeitraum, optional gruppiert nach Zeit und Subshop.

Wird der Parameter aggregation gesetzt (hour, day oder month; ohne “s”), erfolgt die Ausgabe gruppiert nach Zeit. Zusätzlich kann über den Filter subshopId eine Einschränkung auf bestimmte Subshops erfolgen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Um bei Aggregierten Daten die Absprungsrate auszurechnen, muss man mit GET statistics/access/totalSessionCount die Anzahl der Sitzungen für jeden Subshop holen und filteredSessionsCount.value durch diese Anzahl teilen. Bei nicht aggregierten – einfach die Antwort durch die Anzahl an Sitzungen in demselben Zeitraum.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/sessionsWithoutRouting?from=2025-05-08T22:00:00.226Z&to=2025-05-15T21:59:59.226Z&aggregation=day&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort (aggregierte Daten)

{
    "items": [
        {
            "count": 0,
            "key": 1746662400000,
            "key_as_string": "2025-05-08T00:00:00.000Z",
            "subshops": {
                "buckets": [],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        {
            "count": 225,
            "key": 1746748800000,
            "key_as_string": "2025-05-09T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 224,
                        "filteredSessionsCount": {
                            "value": 17
                        },
                        "key": "deutsch",
                        "sessions": {
                            "buckets": [
                                {
                                    "count": 1,
                                    "key": "0be4a6fc98c6f6ae5cb62ce74389970e2f6e498602ae9b311fa31661bab87cda",
                                    "logs_per_session": {
                                        "value": 1
                                    }
                                },
                                {
                                    "count": 1,
                                    "key": "0f87fa4ba5e977dfeb7e6efa1090ba0ae23cbad879920764b9ef662084aeacee",
                                    "logs_per_session": {
                                        "value": 1
                                    }
                                },
                                ...
                            ],
                            "doc_count_error_upper_bound": 0,
                            "sum_other_doc_count": 0
                        }
                    },
                    {
                        "count": 1,
                        "filteredSessionsCount": {
                            "value": 1
                        },
                        "key": "englisch",
                        "sessions": {
                            "buckets": [
                                {
                                    "count": 1,
                                    "key": "9812acafed4ec9b861a36d93c4ab5ecc233a4878816d28115f80c9753f60a1f3",
                                    "logs_per_session": {
                                        "value": 1
                                    }
                                }
                            ],
                            "doc_count_error_upper_bound": 0,
                            "sum_other_doc_count": 0
                        }
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        {
            "count": 45,
            "key": 1746835200000,
            "key_as_string": "2025-05-10T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 45,
                        "filteredSessionsCount": {
                            "value": 45
                        },
                        "key": "deutsch",
                        "sessions": {
                            "buckets": [
                                {
                                    "count": 1,
                                    "key": "03d8ace9db7bcf1561085682171bde8ca5f61f31c90a86012ece5991c384f8b4",
                                    "logs_per_session": {
                                        "value": 1
                                    }
                                },
                                {
                                    "count": 1,
                                    "key": "07cba5bf5610783ef77f4a5890f8d974b081f0b4dd137ccd6a28e049d6c50dc5",
                                    "logs_per_session": {
                                        "value": 1
                                    }
                                },
                                ...
                            ],
                            "doc_count_error_upper_bound": 0,
                            "sum_other_doc_count": 0
                        }
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        ...
    ]
}

Antwort (nicht aggregierte Daten)

3.0

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/totalSessionCount

Dieser Endpunkt liefert die Gesamtanzahl aller Sitzungen im angegebenen Zeitraum, optional gruppiert nach einem Aggregationsintervall.

Wird der Parameter aggregation gesetzt (hour, day oder month; ohne “s”), erfolgt die Ausgabe gruppiert nach Zeit. Zusätzlich kann über den Filter subshopId eine Einschränkung auf bestimmte Subshops erfolgen. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/totalSessionCount?from=2025-05-08T22:00:00.226Z&to=2025-05-15T21:59:59.226Z&aggregation=day&filter_eq[subshopId]=englisch

Antwort (aggregierte Daten)

{
    "items": [
        {
            "count": 3,
            "key": 1744761600000,
            "key_as_string": "2025-04-16T00:00:00.000Z",
            "uniqueSessions": {
                "value": 3
            }
        },
        {
            "count": 24,
            "key": 1744848000000,
            "key_as_string": "2025-04-17T00:00:00.000Z",
            "uniqueSessions": {
                "value": 8
            }
        },
        {
            "count": 1,
            "key": 1744934400000,
            "key_as_string": "2025-04-18T00:00:00.000Z",
            "uniqueSessions": {
                "value": 1
            }
        },
        {
            "count": 2,
            "key": 1745020800000,
            "key_as_string": "2025-04-19T00:00:00.000Z",
            "uniqueSessions": {
                "value": 2
            }
        },
        {
            "count": 1,
            "key": 1745107200000,
            "key_as_string": "2025-04-20T00:00:00.000Z",
            "uniqueSessions": {
                "value": 1
            }
        },
        {
            "count": 1,
            "key": 1745193600000,
            "key_as_string": "2025-04-21T00:00:00.000Z",
            "uniqueSessions": {
                "value": 1
            }
        },
        {
            "count": 386,
            "key": 1745280000000,
            "key_as_string": "2025-04-22T00:00:00.000Z",
            "uniqueSessions": {
                "value": 35
            }
        },
        ...
    ]
}

Antwort (nicht aggregierte Daten)

25544

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/referer

Dieser Endpunkt liefert eine Liste der Referrer-Domains, über die Besucher im angegebenen Zeitraum auf den Shop gelangt sind.

Die Auswertung kann über den Filter subshopId auf einzelne Subshops eingegrenzt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/referer?from=2025-05-08T22:00:00.388Z&to=2025-05-15T21:59:59.388Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort

{
    "items": [
        {
            "count": 1089,
            "key": "test-mgoepfrich.shop.websale.net"
        },
        {
            "count": 143,
            "key": "localhost:8000"
        },
        {
            "count": 5,
            "key": "test-mgoepfrich-en.shop.websale.net"
        },
        {
            "count": 3,
            "key": "test-mgoepfrich.shop.websale.net:443"
        },
        {
            "count": 3,
            "key": "websale.atlassian.net"
        },
        {
            "count": 2,
            "key": "185.126.240.133:80"
        },
        {
            "count": 1,
            "key": "www.google.com"
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/countries

Dieser Endpunkt liefert eine Übersicht über die Anzahl der Seitenaufrufe nach Herkunftsländern im angegebenen Zeitraum.

Die Auswertung kann über den Filter subshopId auf bestimmte Subshops eingeschränkt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/countries?from=2025-04-15T22:00:00.225Z&to=2025-05-15T21:59:59.225Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort

{
    "items": [
        {
            "count": 73684,
            "key": "DE"
        },
        {
            "count": 36390,
            "key": "US"
        },
        {
            "count": 21731,
            "key": "AT"
        },
        {
            "count": 125,
            "key": "SG"
        },
        {
            "count": 22,
            "key": "CA"
        },
        {
            "count": 20,
            "key": "SC"
        },
        {
            "count": 19,
            "key": "IE"
        },
        {
            "count": 17,
            "key": "CH"
        },
        {
            "count": 11,
            "key": "FR"
        },
        {
            "count": 7,
            "key": "AU"
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/lengthOfStay

Dieser Endpunkt liefert die durchschnittliche Verweildauer in Sekunden für einen definierten Zeitraum, optional gruppiert nach einem übergebenen Aggregationsintervall.

Der Parameter aggregation soll immer vorkommen. Die Aggregation erfolgt über die Werte hours, days oder months, bei anderen Werten gibt es keine Aggregation. Zusätzlich kann über den Filter subshopId die Auswertung auf bestimmte Subshops eingegrenzt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/lengthOfStay?from=2024-05-31T22:00:00.168Z&to=2025-05-31T21:59:59.168Z&aggregation=months&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort (aggregierte Daten)

{
    "items": [
        {
            "subshopId": "deutsch",
            "timestamp": "2025-02-26 08:41:12",
            "value": 162
        },
        {
            "subshopId": "deutsch",
            "timestamp": "2025-03-01 16:21:41",
            "value": 37
        },
        {
            "subshopId": "deutsch",
            "timestamp": "2024-11-07 15:31:17",
            "value": 857
        },
        {
            "subshopId": "english",
            "timestamp": "2024-11-06 13:41:37",
            "value": 610
        }
    ]
}

Antwort (nicht aggregierte Daten)

{
    "items": [
        {
            "subshopId": "deutsch",
            "timestamp": "2024-11-06 13:41:37",
            "value": 352
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/allPageViews

Dieser Endpunkt liefert die Gesamtanzahl aller Seitenaufrufe im angegebenen Zeitraum, optional gruppiert nach Zeitintervall und Subshop.

Wird der Parameter aggregation übergeben (hour, day oder month; ohne “s”), werden die Daten entsprechend gruppiert zurückgegeben. Über den Filter subshopId kann die Auswertung auf einzelne Subshops eingegrenzt werden. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/allPageViews?from=2025-05-14T09:00:00.247Z&to=2025-05-15T08:59:59.247Z&aggregation=hour&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=englisch

Antwort (aggregierte Daten)

{
    "items": [
        {
            "count": 2649,
            "key": 1746662400000,
            "key_as_string": "2025-05-08T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 1390,
                        "key": "deutsch"
                    },
                    {
                        "count": 1259,
                        "key": "englisch"
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        {
            "count": 8209,
            "key": 1746748800000,
            "key_as_string": "2025-05-09T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 4383,
                        "key": "deutsch"
                    },
                    {
                        "count": 3826,
                        "key": "englisch"
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        {
            "count": 7727,
            "key": 1746835200000,
            "key_as_string": "2025-05-10T00:00:00.000Z",
            "subshops": {
                "buckets": [
                    {
                        "count": 3897,
                        "key": "deutsch"
                    },
                    {
                        "count": 3830,
                        "key": "englisch"
                    }
                ],
                "doc_count_error_upper_bound": 0,
                "sum_other_doc_count": 0
            }
        },
        ...
    ]
}

Antwort (nicht aggregierte Daten)

13126

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/accountType

Dieser Endpunkt liefert eine Auswertung der Kundentypen, die im angegebenen Zeitraum auf den Shop zugegriffen haben.

Die Analyse erfolgt optional gefiltert nach einem oder mehreren Subshops. Ohne Filter werden alle Subshops berücksichtigt. Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Mögliche Werte für accountType:

-1 → Nicht ausgewählt
0 → Gast
1 → Neukunde
2 → Kunde

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/accountType?from=2024-05-31T22:00:00.979Z&to=2025-05-31T21:59:59.979Z&filter_eq[subshopId]=deutsch&filter_eq[subshopId]=english

Antwort

{
    "items": [
        {
            "accountType": -1,
            "data": 33
        },
        {
            "accountType": 1,
            "data": 1
        },
        {
            "accountType": 2,
            "data": 15
        }
    ]
}

Filterfelder

subshopID

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/browserList

Dieser Endpunkt liefert eine Liste aller Browser, mit denen auf den Shop zugegriffen wurde, einschließlich der jeweiligen Zugriffszahlen.

Die Daten dienen der Analyse der im Einsatz befindlichen Browser bei Shop-Besuchern. Im Gegensatz zu GET statistics/access/browser muss der Zeitraum nicht angegeben werden.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/browserList

Antwort

{
    "items": [
        {
            "count": 22228,
            "key": "Chrome"
        },
        {
            "count": 33,
            "key": "Firefox"
        },
        {
            "count": 21,
            "key": "Edge"
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/OSList

Dieser Endpunkt liefert eine Übersicht aller Betriebssysteme, über die Zugriffe auf den Shop erfolgt sind, inklusive der jeweiligen Zugriffszahlen.

Die Daten ermöglichen eine Auswertung der verwendeten Plattformen durch Shop-Besucher. Im Gegensatz zu GET statistics/access/os muss der Zeitraum nicht angegeben werden.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/OSList

Antwort

{
    "items": [
        {
            "count": 81353,
            "key": "Other"
        },
        {
            "count": 32327,
            "key": "Android"
        },
        {
            "count": 9243,
            "key": "Windows"
        },
        {
            "count": 411,
            "key": "Linux"
        },
        {
            "count": 65,
            "key": "Mac OS X"
        },
        {
            "count": 14,
            "key": "Ubuntu"
        },
        {
            "count": 3,
            "key": "iOS"
        },
        {
            "count": 1,
            "key": "Maemo"
        },
        {
            "count": 1,
            "key": "Symbian^3"
        }
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

GET statistics/access/actionsList

Dieser Endpunkt liefert eine Liste aller im Shop erfassten Aktionen sowie deren jeweilige Häufigkeit.

Die Daten geben Aufschluss darüber, wie oft bestimmte Nutzeraktionen wie Seitenaufrufe oder Checkout-Schritte erfolgt sind. Im Gegensatz zu GET statistics/access/action muss der Zeitraum nicht angegeben werden.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/access/actionsList

Antwort

{
    "items": [
        {
            "count": 1043627,
            "key": "ViewShow"
        },
        {
            "count": 663337,
            "key": "StartpageShow"
        },
        {
            "count": 387712,
            "key": "CategoryShow"
        },
        {
            "count": 95638,
            "key": "ProductShow"
        },
        {
            "count": 32215,
            "key": "SearchShow"
        },
        {
            "count": 25625,
            "key": "CheckoutSetFreeFields"
        },
        {
            "count": 22610,
            "key": "CheckoutAccountTypeSelect"
        },
        {
            "count": 11619,
            "key": "CheckoutConfirm"
        },
        {
            "count": 9457,
            "key": "DirectOrderAdd"
        },
        {
            "count": 7931,
            "key": "InquirySend"
        },
        ...
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

Weitere Endpunkte

GET statistics/newlyRegistered

Dieser Endpunkt liefert die Anzahl der Neuregistrierungen im angegebenen Zeitraum, gruppiert nach einem wählbaren Aggregationsintervall.

Der Zeitraum wird über die Parameter from und to im ISO-8601-Format festgelegt. Die Aggregation erfolgt in Stunden, Tagen oder Monaten; andere Werte werden automatisch entsprechend konvertiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/newlyRegistered?from=2025-04-27T22:00:00.000Z&to=2025-05-9T14:53:01.470Z&aggregation=days

Antwort

[
    {
        "timestamp": "2025-04-27T22:00:00.000Z",
        "value": 1
    },
    {
        "timestamp": "2025-04-28T22:00:00.000Z",
        "value": 1
    },
    {
        "timestamp": "2025-04-29T22:00:00.000Z",
        "value": 4
    },
    {
        "timestamp": "2025-04-30T22:00:00.000Z",
        "value": 0
    },
    {
        "timestamp": "2025-05-01T22:00:00.000Z",
        "value": 0
    },
    {
        "timestamp": "2025-05-02T22:00:00.000Z",
        "value": 0
    },
    {
        "timestamp": "2025-05-03T22:00:00.000Z",
        "value": 0
    },
    {
        "timestamp": "2025-05-04T22:00:00.000Z",
        "value": 2
    },
    {
        "timestamp": "2025-05-05T22:00:00.000Z",
        "value": 0
    },
    {
        "timestamp": "2025-05-06T22:00:00.000Z",
        "value": 6
    },
    {
        "timestamp": "2025-05-07T22:00:00.000Z",
        "value": 0
    },
    {
        "timestamp": "2025-05-08T22:00:00.000Z",
        "value": 3
    }
]

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from, to oder aggregation fehlen.
400 Bad Request	”invalidValue”

POST statistics/visitors

Dieser Endpunkt liefert die täglichen Besucherzahlen der Subshops für einen frei wählbaren Zeitraum.

Der Zeitraum wird über die Parameter from und to im ISO-8601-Format definiert.

Für die Nutzung sind Leseberechtigungen für Statistiken erforderlich.

Beispiel

https://www.<ihr-shop>.de/admin/api/v1/statistics/visitors?from=2025-04-19T22:00:00.000Z&to=2025-05-14T15:07:02.027Z

Antwort

{
    "items": [
        {
            "appUsersNumber": 0,
            "date": "2025-04-20T00:00:00Z",
            "ordersNumber": 0,
            "subshopId": "deutsch",
            "visitorsNumber": 2
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-21T00:00:00Z",
            "ordersNumber": 0,
            "subshopId": "deutsch",
            "visitorsNumber": 1
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-22T00:00:00Z",
            "ordersNumber": 0,
            "subshopId": "deutsch",
            "visitorsNumber": 18
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-23T00:00:00Z",
            "ordersNumber": 4,
            "subshopId": "deutsch",
            "visitorsNumber": 14
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-24T00:00:00Z",
            "ordersNumber": 0,
            "subshopId": "deutsch",
            "visitorsNumber": 12
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-25T00:00:00Z",
            "ordersNumber": 1,
            "subshopId": "deutsch",
            "visitorsNumber": 8
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-26T00:00:00Z",
            "ordersNumber": 0,
            "subshopId": "deutsch",
            "visitorsNumber": 15
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-28T00:00:00Z",
            "ordersNumber": 1,
            "subshopId": "deutsch",
            "visitorsNumber": 24
        },
        {
            "appUsersNumber": 0,
            "date": "2025-04-28T00:00:00Z",
            "ordersNumber": 0,
            "subshopId": "englisch",
            "visitorsNumber": 19
        },
        ...
    ]
}

Fehlercodes

Fehler	Typ	Grund
401 Unauthorized		Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Statistiken.
400 Bad Request	”missing”	Die Parameter from oder to fehlen.
400 Bad Request	”invalidValue”	from oder to enthalten keine validen ISO 8601 Zeitwerte.
503 Service Unavailable	”internalError”	Statistiken konnten nicht geladen werden.

Support

Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum Kundenportal

Bitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.