EDD REST API – Estatísticas

A
EDD REST API pode retornar uma grande quantidade de informações estatísticas sobre sua loja usando o endpoint /stats/. A consulta de estatísticas é usada para recuperar estatísticas de ganhos/vendas de sua loja. Ela pode ser usada para recuperar ganhos totais para o mês atual, ano passado, um intervalo de datas específico, etc., bem como as mesmas opções para vendas. Ela também pode ser usada para recuperar estatísticas de ganhos / vendas para qualquer ou todos os produtos.

O endpoint de estatísticas é:

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

Note que a consulta de
estatísticas requer que um parâmetro type seja passado. Existem duas opções de tipo:

• sales – Para recuperar estatísticas de vendas.
• earnings – Para recuperar estatísticas de ganhos.

Ambos os tipos de consulta
sales e earnings incluem parâmetros adicionais para opções de data e produto:

• date – A data para a qual recuperar ganhos ou vendas. Isso tem três valores aceitos:
  • today – Recuperará estatísticas para o dia atual.
  • yesterday – Recuperará estatísticas para o dia anterior.
  • range – Recuperará estatísticas para um intervalo de datas.
    • startdate – Formato: YYYYMMDD. Exemplo: 20120224 = 24/02/2012
    • enddate – Formato: YYYYMMDD. Exemplo: 20120531 = 31/05/2012
• product – usado para recuperar estatísticas de vendas ou ganhos para um produto específico, ou todos os produtos. Esta opção tem dois valores aceitos:
  • # – O ID do produto para o qual recuperar estatísticas.
  • all – Recuperar estatísticas para todos os produtos. Esta opção não suporta paginação.

Nota: as opções product e date não podem ser combinadas. Você só pode usar uma ou outra.

Uma consulta básica de estatísticas de ganhos se parece com isto:

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

E a resposta é:

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

Uma consulta básica de estatísticas de vendas se parece com isto:

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

E a resposta é:

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

Se estiver passando uma data de
today ou yesterday, a consulta se parece com isto:

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

E a resposta:

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

Se estiver passando um intervalo de datas, a consulta será:

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

E a resposta:

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

Cada item no objeto
sales representa o dia e o valor é o montante.

Se estiver passando o parâmetro
product, assim

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

a resposta será:

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

Ou para um produto individual:

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

Resposta:

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