/bff/voucher/dashboard-summary

Returns org-wide voucher KPIs powering the dashboard tile bar above the voucher list: total count, active count, expiring-soon count (next 30 days), gift-card count, never-used count, hot codes count (redeemed in the last 7 days), total revenue from paid orders that used a voucher, total committed cost, ROI ratio (revenue/cost), and unique paid customers.

VouchergetBffVoucherDashboard-summary

No parameters

This endpoint takes no path, query, header or body parameters.

Request

GET /bff/voucher/dashboard-summary

get

curl -X GET "https://api.bizkithub.com/bff/voucher/dashboard-summary" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Voucher dashboard KPI summary.

{
  "totalCount": 0,
  "activeCount": 0,
  "expiringSoonCount": 0,
  "giftCardCount": 0,
  "unusedCount": 0,
  "hotCount": 0,
  "totalRevenue": "example_totalRevenue",
  "totalCost": "example_totalCost",
  "uniqueCustomers": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key