De
EDD REST API kan veel statistische informatie over uw winkel retourneren met behulp van de /stats/ eindpunt. De stats query wordt gebruikt voor het ophalen van verdiensten/verkoopstatistieken van uw winkel. Het kan worden gebruikt om totale verdiensten voor de huidige maand, vorig jaar, een specifieke datumbereik, enz. op te halen, evenals dezelfde opties voor verkopen. Het kan ook worden gebruikt voor het ophalen van verdiensten / verkoopstatistieken voor een of alle producten.
Het stats eindpunt is:
https://example.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=
Merk op dat de
stats query een type parameter vereist. Er zijn twee type opties:
- sales – Voor het ophalen van verkoopstatistieken.
- earnings – Voor het ophalen van verdienstenstatistieken.
Beide
sales en earnings query types bevatten aanvullende parameters voor datum- en productopties:
- date – De datum om verdiensten of verkopen voor op te halen. Dit heeft drie geaccepteerde waarden:
- today – Haalt statistieken op voor de huidige dag.
- yesterday – Haalt statistieken op voor de vorige dag.
- range – Haalt statistieken op voor een datumbereik.
- startdate – Formaat: YYYYMMDD. Voorbeeld: 20120224 = 2012/02/24
- enddate – Formaat: YYYYMMDD. Voorbeeld: 20120531 = 2012/02/24
- product – gebruikt om verkoop- of verdienstenstatistieken op te halen voor een specifiek product, of alle producten. Deze optie heeft twee geaccepteerde waarden:
- # – De product-ID om statistieken voor op te halen.
- all – Haalt statistieken op voor alle producten. Deze optie ondersteunt geen paginering.
Opmerking: de product en date opties kunnen niet worden gecombineerd. U kunt slechts één van beide gebruiken.
Een basis query voor verdienstenstatistieken ziet er als volgt uit:
https://example.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=earnings
En de respons is:
{
"earnings": {
"current_month": 20,
"last_month": 311.96,
"totals": 1302.2764
}
}
Een basis query voor verkoopstatistieken ziet er als volgt uit:
https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales
En de respons is:
{
"sales": {
"current_month": 1,
"last_month": 18,
"totals": 71
}
}
Als u een datum van
vandaag of gisteren doorgeeft, ziet de query er als volgt uit:
https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&date=today
En de respons:
{
"sales": {
"today": 1
}
}
Als u een datumbereik doorgeeft, zal de query zijn:
https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&date=range&startdate=20130201&enddate=20130210
En de respons:
{
"totals": 12,
"sales": {
"20130201": 0,
"20130202": 0,
"20130203": 0,
"20130204": 0,
"20130205": 0,
"20130206": 1,
"20130207": 0,
"20130208": 0,
"20130209": 11,
"20130210": 0
}
}
Elk item in het
sales object vertegenwoordigt de dag en de waarde is het bedrag.
Als u de
product parameter doorgeeft, als volgt
https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&product=all
zal de respons zijn:
{
"sales": [
{
"test-2": "6"
},
{
"simple-notices-pro": "48"
},
{
"love-it-pro": "13"
},
{
"test-product-2-2": "0"
},
{
"test-product-1-2": "0"
}
]
}
Of voor een individueel product:
https://yoursite.com/edd-api/stats/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&type=sales&product=16
Respons:
{
"sales": [
{
"simple-notices-pro": "48"
}
]
}
