API REST EDD – Statistiques

L' API REST EDD peut retourner une grande quantité d'informations statistiques sur votre boutique en utilisant le point de terminaison /stats/. La requête stats est utilisée pour récupérer les statistiques de gains/ventes de votre boutique. Elle peut être utilisée pour récupérer les gains totaux du mois en cours, de l'année dernière, d'une période spécifique, etc., ainsi que les mêmes options pour les ventes. Elle peut également être utilisée pour récupérer les statistiques de gains / ventes pour n'importe quel produit ou tous les produits.

Le point de terminaison stats est :

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

Notez que la requête stats nécessite un paramètre type. Il existe deux options de type :

• sales – Pour récupérer les statistiques de ventes.
• earnings – Pour récupérer les statistiques de gains.

Les deux types de requêtes sales et earnings incluent des paramètres supplémentaires pour les options de date et de produit :

• date – The date to retrieve earnings or sales for. This has three accepted values:
  • today – Récupérera les statistiques pour la journée en cours.
  • yesterday – Récupérera les statistiques pour la journée précédente.
  • range – Will retrieve stats for a date range.
    • startdate – Format : YYYYMMDD. Exemple : 20120224 = 24/02/2012
    • enddate – Format : YYYYMMDD. Exemple : 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:
  • # – L'ID du produit pour lequel récupérer les statistiques.
  • all – Récupérer les statistiques pour tous les produits. Cette option ne prend pas en charge la pagination.

Note : les options product et date ne peuvent pas être combinées. Vous ne pouvez utiliser que l'une ou l'autre.

Une requête de base pour les statistiques de gains ressemble à ceci :

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

Et la réponse est :

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

Une requête de base pour les statistiques de ventes ressemble à ceci :

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

Et la réponse est :

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

Si vous passez une date de today ou yesterday, la requête ressemble à ceci :

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

Et la réponse :

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

Si vous passez une plage de dates, la requête sera :

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

Et la réponse :

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

Chaque élément de l'objet sales représente le jour et la valeur est le montant.

Si vous passez le paramètre product, comme ceci

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

la réponse sera :

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

Ou pour un produit individuel :

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

Réponse :

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