/bff/voucher/statistics

Returns analytics and statistics for a specific voucher including total revenue generated, average order value, unique customer count, and usage breakdown by order status.

VouchergetBffVoucherStatistics

Parameters

1 query

1 total

Query · 1

codestringRequired

Voucher code to get statistics for.

Request

GET /bff/voucher/statistics

get

curl -X GET "https://api.bizkithub.com/bff/voucher/statistics?code=SUMMER2024" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Voucher statistics or null.

{
  "totalOrders": 0,
  "totalRevenue": "example_totalRevenue",
  "averageOrderValue": "example_averageOrderValue",
  "uniqueCustomers": 0,
  "usageByStatus": {
    "paid": 0,
    "pending": 0,
    "cancelled": 0
  },
  "isExpired": false,
  "isActive": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key