BizKitHub Developer Documentation

Parameters

1 query

Query parameters

· 1

daysnumberOptional

Number of days to analyze. Defaults to 30.

Default: 30

Example30

Response schema

1 status code documented

200SuccessVoucher performance analysis.

summaryobjectRequired

ordersWithVouchernumberRequired

Orders using a voucher.

ordersTotalnumberRequired

Total paid orders.

voucherUsageRatenumberRequired

Voucher usage rate (0-100%).

revenueWithVouchernumberRequired

Revenue from voucher orders.

revenueTotalnumberRequired

Total revenue.

totalDiscountnumberRequired

Total discount amount given.

avgDiscountPerOrdernumberRequired

Average discount per order.

topVouchersobject[]Required

Top 10 vouchers by usage.

Each array item:

voucherIdnumberRequired

Voucher ID.

voucherCodestringRequired

Voucher code.

voucherTypestringRequired

Voucher type name.

voucherValuestringRequired

Voucher value.

usageCountnumberRequired

Times used.

revenuenumberRequired

Revenue from orders with this voucher.

byTypeobject[]Required

Vouchers grouped by type.

Each array item:

typeIdnumberRequired

Voucher type ID.

typeNamestringRequired

Voucher type name.

usageCountnumberRequired

Usage count.

revenuenumberRequired

Revenue generated.

currencystringRequired

Currency code.

Response example

application/json

{
  "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"
}

/bff/dashboard/voucher-performance