/bff/dashboard/voucher-performance

Analyzes effectiveness of discount codes. Shows whether vouchers drive revenue or just burn margin.

DashboardgetBffDashboardVoucher-performance

Parameters

1 query

1 total

Query · 1

daysnumber

Number of days to analyze. Defaults to 30.

Default: 30

Request

GET /bff/dashboard/voucher-performance

get

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

Response

Voucher performance analysis.

{
  "summary": {
    "ordersWithVoucher": 0,
    "ordersTotal": 0,
    "voucherUsageRate": 0,
    "revenueWithVoucher": 0,
    "revenueTotal": 0,
    "totalDiscount": 0,
    "avgDiscountPerOrder": 0
  },
  "topVouchers": [
    {
      "voucherId": 0,
      "voucherCode": "example_voucherCode",
      "voucherType": "example_voucherType",
      "voucherValue": "example_voucherValue",
      "usageCount": 0,
      "revenue": 0
    }
  ],
  "byType": [
    {
      "typeId": 0,
      "typeName": "example_typeName",
      "usageCount": 0,
      "revenue": 0
    }
  ],
  "currency": "example_currency"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key