EDD REST API – 統計

/stats/ エンドポイントを使用して、
EDD REST API はストアに関する多くの統計情報を返すことができます。stats クエリは、ストアからの収益/売上の統計を取得するために使用されます。現在の月、昨年、特定の期間の合計収益を取得するために使用できます。また、売上についても同様のオプションがあります。すべての製品、または任意の製品の収益/売上の統計を取得するためにも使用できます。

stats エンドポイントは次のとおりです。

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

stats クエリには、type パラメータを渡す必要があることに注意してください。2 つのタイプ オプションがあります。

• sales – 売上統計を取得するため。
• earnings – 収益統計を取得するため。

sales および earnings の両方のクエリタイプには、日付と製品のオプションを追加するパラメータが含まれています。

• date – 収益または売上の取得対象日。次の 3 つの値が受け入れられます。
  • today – 現在の日の統計を取得します。
  • yesterday – 前日の統計を取得します。
  • range – 日付範囲の統計を取得します。
    • startdate – フォーマット：YYYYMMDD。例：20120224 = 2012/02/24
    • enddate – フォーマット：YYYYMMDD。例：20120531 = 2012/02/24
• product – 特定の製品、またはすべての製品の売上または収益統計を取得するために使用されます。このオプションには 2 つの値が受け入れられます。
  • # – 統計を取得する製品 ID。
  • all – すべての製品の統計を取得します。このオプションは ページネーション をサポートしていません。

注意: product および date オプションは組み合わせることができません。どちらか一方のみを使用できます。

基本的な収益統計クエリは次のようになります。

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

そしてレスポンスは次のとおりです。

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

基本的な売上統計クエリは次のようになります。

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

そしてレスポンスは次のとおりです。

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

today または yesterday の日付を渡す場合、クエリは次のようになります。

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

そしてレスポンスは次のとおりです。

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

日付範囲を渡す場合、クエリは次のようになります。

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

そしてレスポンスは次のとおりです。

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

sales オブジェクトの各項目は日を表し、値はその金額です。

次のように product パラメータを渡す場合

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

レスポンスは次のようになります。

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

または個々の製品の場合：

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

レスポンス：

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