/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

Parameters

No parameters required

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

Response schema

1 status code documented

200SuccessVoucher dashboard KPI summary.

totalCountnumberRequired

Total number of vouchers in the organisation.

activeCountnumberRequired

Vouchers currently usable (active flag + within validity + under limit).

expiringSoonCountnumberRequired

Active vouchers whose validTo falls within the next 30 days.

giftCardCountnumberRequired

Vouchers generated from a source order (product-voucher template).

unusedCountnumberRequired

Vouchers created at least 30 days ago that have never been redeemed.

hotCountnumberRequired

Vouchers redeemed at least once in the last 7 days.

totalRevenuestringRequired

Sum of shop__order.price for paid orders that used any voucher in this org. Stringified for precision.

totalCoststringRequired

Sum of shop__voucher.cost across all vouchers in this org (org default currency). Stringified for precision.

totalRoinumber | nullRequired

Revenue / cost ratio. Null when totalCost is 0.

One of 2:

Variant 1

number

Variant 2

null

uniqueCustomersnumberRequired

Distinct customers across paid orders that used any voucher in this org.

Response example

application/json

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

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key