Driffle Seller API
  • Driffle Seller API
  • Guide
    • Getting Started
    • Monitoring Your Competition
  • FAQ
    • Cannot use the API, it throws 401/403/404 errors
  • Reference
    • Automate Your Stock with "Declare Stock"
    • API Reference
      • Products
        • Get Products List
        • Get Single product
        • Get Product Commission
      • Competition
      • Offers (Auction)
        • Offers List
        • Get Single Offer
        • Update Offer Price
        • Enable/Disable Offers
        • Create a new offer
        • Update Offer
        • Bulk Update Offers
      • Manage Inventory/Stock
        • Declare Stock
        • Upload Stock
        • Inventory Actions
        • Fetch a single Key
      • Transactions
        • Get Transactions List
        • Get a Single Transaction
      • Dashboard Stats
      • Regions
      • Platforms
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Dashboard Stats

PreviousGet a Single TransactionNextRegions

Last updated 1 year ago

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

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

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
    }
  }
}
{
    "message": "Bad Request. Wrong/Invalid params format.",
    "statusCode": 400 
}
{
    "message": "UnAuthorized request. Invalid/Expired token",
    "statusCode": 401
}
{
    "message": "Forbidden Request. Action not allowed or Rate Limit exhausted.", 
    "statusCode": 403
}
{
    "message": "Internal Server Error",
    "statusCode": 500
}
get
Header parameters
AuthorizationstringRequired

Authorization token in Bearer format. Example: Bearer dvakycjgw8liyd278y

Responses
200
Default Response
application/json
400
Bad Request. Wrong/Invalid params format.
application/json
401
UnAuthorized request. Invalid/Expired token
application/json
403
Forbidden Request. Action not allowed or Rate Limit exhausted.
application/json
500
Server Error.
application/json
get
GET /api/seller/legacy/dashboard HTTP/1.1
Host: services.driffle.com
Authorization: text
Accept: */*
{
  "message": "text",
  "statusCode": 1,
  "data": {
    "dailyOrdersData": [
      {
        "day": "text",
        "amountProcessed": 1,
        "keysProcessed": 1,
        "ordersProcessed": 1,
        "productsSold": 1
      }
    ],
    "balanceData": {
      "totalBal": 1,
      "onHoldBal": 1,
      "withdrawalBal": 1,
      "refundedBal": 1,
      "totalWithdrawn": 1,
      "totalEarnings": 1,
      "totalVatAmount": 1,
      "totalUnfulfilledSaleFee": 1
    }
  }
}