Dashboard Stats

The following API return you the the balance stats & Daily order stats .

Daily Order Stats:

  • Amount Processed: Total sales amount for current day

  • Keys Processed: Total keys sold today

  • Orders Processed: Total orders processed today

  • Products Sold: Number of unique products sold today

Balance Data:

  • totalEarnings: Total Earnings (Withdrawable balance + Balance on hold + Refunds + Total Withdrawn)

  • onHoldBalance: Amount on hold for +7 days after the sale.

  • withdrawalBal: Amount available for withdrawal

  • refundedBal: Amount refunded so far

  • totalWithdrawn: Amount withdrawn so far

All the stats are calculated as per GMT timezone and this might be different from the stats in your dashboard, since on the dashboard it is calculated taking the User's local timezone as reference.

GET /dashboard

Headers

Response

{
  "message": "string",
  "statusCode": 200,
  "data": {
    "dailyOrdersData": [
      {
        "day": "string",
        "amountProcessed": 0,
        "keysProcessed": 0,
        "ordersProcessed": 0,
        "productsSold": 0
      }
    ],
    "balanceData": {
      "totalBal": 0,
      "onHoldBal": 0,
      "withdrawalBal": 0,
      "refundedBal": 0,
      "totalWithdrawn": 0,
      "totalEarnings": 0,
      "totalVatAmount": 0,
      "totalUnfulfilledSaleFee": 0
    }
  }
}

Last updated