BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/order-funnel
getDashboardAdmin BFF

/bff/dashboard/order-funnel

Shows conversion rates at each stage: cart → order → paid → completed. Identifies where UX or system issues lose money.

DashboardgetBffDashboardOrder-funnel

Parameters

1 query

Query parameters

· 1
daysnumberOptional

Number of days to analyze. Defaults to 30.

Default: 30
Example30

Response schema

1 status code documented

200SuccessOrder funnel analysis.
stagesobjectRequired
cartsCreatednumberRequired

Total carts created.

cartsWithItemsnumberRequired

Carts with at least one item.

ordersCreatednumberRequired

Orders created from carts.

ordersPaidnumberRequired

Orders successfully paid.

ordersCompletednumberRequired

Orders marked as completed.

ordersCancellednumberRequired

Orders cancelled/storno.

conversionRatesobjectRequired
cartToOrdernumberRequired

Cart to order conversion (0-100%).

orderToPaidnumberRequired

Order to paid conversion (0-100%).

paidToCompletednumberRequired

Paid to completed rate (0-100%).

overallConversionnumberRequired

Cart to paid overall (0-100%).

cancellationRatenumberRequired

Cancellation rate (0-100%).

abandonedByStatusobject[]Required

Abandoned orders by status.

Each array item:
statusCodestringRequired

Order status code.

statusLabelstringRequired

Status label.

countnumberRequired

Number of abandoned orders.

dailyTrendobject[]Required

Daily conversion trend.

Each array item:
datestringRequired

Date (YYYY-MM-DD).

ordersCreatednumberRequired

Orders created.

ordersPaidnumberRequired

Orders paid.

conversionRatenumberRequired

Daily conversion rate (0-100%).

Response example

application/json
{
  "stages": {
    "cartsCreated": 0,
    "cartsWithItems": 0,
    "ordersCreated": 0,
    "ordersPaid": 0,
    "ordersCompleted": 0,
    "ordersCancelled": 0
  },
  "conversionRates": {
    "cartToOrder": 0,
    "orderToPaid": 0,
    "paidToCompleted": 0,
    "overallConversion": 0,
    "cancellationRate": 0
  },
  "abandonedByStatus": [
    {
      "statusCode": "example_statusCode",
      "statusLabel": "example_statusLabel",
      "count": 0
    }
  ],
  "dailyTrend": [
    {
      "date": "example_date",
      "ordersCreated": 0,
      "ordersPaid": 0,
      "conversionRate": 0
    }
  ]
}

Request example

GET /bff/dashboard/order-funnel

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/order-funnel?days=30" \
  -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