EDD REST API – Statystyki

API REST
EDD może zwracać wiele informacji statystycznych o Twoim sklepie za pomocą punktu końcowego /stats/. Zapytanie stats służy do pobierania statystyk zarobków/sprzedaży z Twojego sklepu. Może być używane do pobierania całkowitych zarobków za bieżący miesiąc, zeszły rok, określony zakres dat itp., a także tych samych opcji dla sprzedaży. Może być również używane do pobierania statystyk zarobków / sprzedaży dla dowolnego lub wszystkich produktów.

Punkt końcowy statystyk to:

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

Należy pamiętać, że zapytanie
stats wymaga przekazania parametru type. Istnieją dwie opcje typu:

• sales – Do pobierania statystyk sprzedaży.
• earnings – Do pobierania statystyk zarobków.

Oba typy zapytań
sales i earnings zawierają dodatkowe parametry dla opcji daty i produktu:

• date – Data, dla której mają być pobrane zarobki lub sprzedaż. Ma ona trzy akceptowane wartości:
  • today – Pobierze statystyki dla bieżącego dnia.
  • yesterday – Pobierze statystyki dla poprzedniego dnia.
  • range – Pobierze statystyki dla zakresu dat.
    • startdate – Format: RRRRMMDD. Przykład: 20120224 = 2012/02/24
    • enddate – Format: RRRRMMDD. Przykład: 20120531 = 2012/02/24
• product – używany do pobierania statystyk sprzedaży lub zarobków dla konkretnego produktu lub wszystkich produktów. Ta opcja ma dwie akceptowane wartości:
  • # – ID produktu, dla którego mają być pobrane statystyki.
  • all – Pobierz statystyki dla wszystkich produktów. Ta opcja nie obsługuje stronicowania.

Uwaga: opcje product i date nie mogą być łączone. Można użyć tylko jednej z nich.

Podstawowe zapytanie o statystyki zarobków wygląda tak:

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

A odpowiedź to:

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

Podstawowe zapytanie o statystyki sprzedaży wygląda tak:

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

A odpowiedź to:

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

Jeśli przekazujesz datę
today lub yesterday, zapytanie wygląda tak:

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

A odpowiedź to:

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

Jeśli przekazujesz zakres dat, zapytanie będzie wyglądać tak:

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

A odpowiedź to:

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

Każdy element w obiekcie
sales reprezentuje dzień, a wartość to kwota.

Jeśli przekazujesz parametr
product, w ten sposób

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

odpowiedź będzie wyglądać tak:

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

Lub dla pojedynczego produktu:

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

Odpowiedź:

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