EDD REST API – Statistiken

Die
EDD REST API kann mithilfe des Endpunkts /stats/ eine Fülle von statistischen Informationen über Ihren Shop zurückgeben. Die Stats-Abfrage dient zum Abrufen von Einnahmen-/Verkaufsstatistiken aus Ihrem Shop. Sie kann verwendet werden, um die Gesamteinnahmen für den aktuellen Monat, das letzte Jahr, einen bestimmten Datumsbereich usw. abzurufen, sowie die gleichen Optionen für Verkäufe. Sie kann auch zum Abrufen von Einnahmen-/Verkaufsstatistiken für jedes oder alle Produkte verwendet werden.

Der Stats-Endpunkt ist:

https://example.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=

Beachten Sie, dass die
Stats-Abfrage einen Type-Parameter erfordert. Es gibt zwei Typoptionen:

• sales – Zum Abrufen von Verkaufsstatistiken.
• earnings – Zum Abrufen von Einnahmenstatistiken.

Beide
Sales- und Earnings-Abfragetypen enthalten zusätzliche Parameter für Datums- und Produktoptionen:

• date – The date to retrieve earnings or sales for. This has three accepted values:
  • today – Ruft Statistiken für den aktuellen Tag ab.
  • yesterday – Ruft Statistiken für den Vortag ab.
  • range – Will retrieve stats for a date range.
    • startdate – Format: YYYYMMDD. Beispiel: 20120224 = 24.02.2012
    • enddate – Format: YYYYMMDD. Beispiel: 20120531 = 31.05.2012
• product – used to retrieve sale or earnings stats for a specific product, or all products. This option has two accepted values:
  • # – Die Produkt-ID, für die Statistiken abgerufen werden sollen.
  • all – Statistiken für alle Produkte abrufen. Diese Option unterstützt keine Paginierung.

Hinweis: Die Optionen product und date können nicht kombiniert werden. Sie können nur eine der beiden verwenden.

Eine grundlegende Abfrage von Einnahmenstatistiken sieht so aus:

https://example.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=earnings

Und die Antwort lautet:

{
    "earnings": {
        "current_month": 20,
        "last_month": 311.96,
        "totals": 1302.2764
    }
}

Eine grundlegende Abfrage von Verkaufsstatistiken sieht so aus:

https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales

Und die Antwort lautet:

{
    "sales": {
        "current_month": 1,
        "last_month": 18,
        "totals": 71
    }
}

Wenn Sie ein Datum von
today oder yesterday übergeben, sieht die Abfrage so aus:

https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&date=today

Und die Antwort:

{
    "sales": {
        "today": 1
    }
}

Wenn Sie einen Datumsbereich übergeben, wird die Abfrage lauten:

https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&date=range&startdate=20130201&enddate=20130210

Und die Antwort:

{
    "totals": 12,
    "sales": {
        "20130201": 0,
        "20130202": 0,
        "20130203": 0,
        "20130204": 0,
        "20130205": 0,
        "20130206": 1,
        "20130207": 0,
        "20130208": 0,
        "20130209": 11,
        "20130210": 0
    }
}

Jeder Eintrag im
Sales-Objekt repräsentiert den Tag und der Wert ist der Betrag.

Wenn Sie den
product-Parameter übergeben, wie hier

https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&product=all

wird die Antwort lauten:

{
    "sales": [
        {
            "test-2": "6"
        },
        {
            "simple-notices-pro": "48"
        },
        {
            "love-it-pro": "13"
        },
        {
            "test-product-2-2": "0"
        },
        {
            "test-product-1-2": "0"
        }
    ]
}

Oder für ein einzelnes Produkt:

https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&product=16

Antwort:

{
    "sales": [
        {
            "simple-notices-pro": "48"
        }
    ]
}