API REST de EDD – Estadísticas

La
API REST de EDD puede devolver una gran cantidad de información estadística sobre tu tienda usando el endpoint /stats/. La consulta de estadísticas se utiliza para recuperar estadísticas de ganancias/ventas de tu tienda. Se puede usar para recuperar las ganancias totales del mes actual, del año pasado, de un rango de fechas específico, etc., así como las mismas opciones para las ventas. También se puede usar para recuperar estadísticas de ganancias/ventas para cualquier producto o para todos.

El endpoint de estadísticas es:

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

Ten en cuenta que la
consulta de stats requiere que se pase un parámetro type. Hay dos opciones de tipo:

• sales – Para recuperar estadísticas de ventas.
• earnings – Para recuperar estadísticas de ganancias.

Ambos tipos de consulta
sales y earnings incluyen parámetros adicionales para opciones de fecha y producto:

• date – La fecha para la que se recuperarán las ganancias o ventas. Tiene tres valores aceptados:
  • today – Recuperará estadísticas para el día actual.
  • yesterday – Recuperará estadísticas para el día anterior.
  • range – Recuperará estadísticas para un rango de fechas.
    • startdate – Formato: YYYYMMDD. Ejemplo: 20120224 = 2012/02/24
    • enddate – Formato: YYYYMMDD. Ejemplo: 20120531 = 2012/02/24
• product – se usa para recuperar estadísticas de ventas o ganancias para un producto específico, o para todos los productos. Esta opción tiene dos valores aceptados:
  • # – El ID del producto para el que se recuperarán las estadísticas.
  • all – Recuperar estadísticas para todos los productos. Esta opción no admite paginación.

Nota: las opciones product y date no se pueden combinar. Solo puedes usar una u otra.

Una consulta básica de estadísticas de ganancias se ve así:

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

Y la respuesta es:

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

Una consulta básica de estadísticas de ventas se ve así:

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

Y la respuesta es:

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

Si se pasa una fecha de
today o yesterday, la consulta se ve así:

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

Y la respuesta:

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

Si se pasa un rango de fechas, la consulta será:

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

Y la respuesta:

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

Cada elemento en el objeto
sales representa el día y el valor es la cantidad.

Si se pasa el parámetro
product, de esta manera

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

la respuesta será:

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

O para un producto individual:

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

Respuesta:

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