BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/orders-by-status
getDashboardAdmin BFF

/bff/dashboard/orders-by-status

Returns order counts and values grouped by status. Helps identify bottlenecks in order processing workflow.

DashboardgetBffDashboardOrders-by-status

Parameters

1 query

Query parameters

· 1
daysnumberOptional

Number of days to analyze. Defaults to 30.

Default: 30
Example30

Response schema

1 status code documented

200SuccessOrders grouped by status.
totalOrdersnumberRequired

Total number of orders in the analyzed period.

totalValuenumberRequired

Total value of all orders.

byStatusobject[]Required

Breakdown by order status, sorted by workflow position.

Each array item:

Status breakdown item.

statusIdnumberRequired

Internal status ID.

statusCodestringRequired

Status code (e.g., "new", "paid", "done", "storno").

statusLabelstringRequired

Human-readable status label.

orderCountnumberRequired

Number of orders in this status.

totalValuenumberRequired

Total value of orders in this status.

percentagenumberRequired

Percentage of total orders (0-100).

currencystringRequired

Currency code for all amounts (e.g., "CZK").

Response example

application/json
{
  "totalOrders": 0,
  "totalValue": 0,
  "byStatus": [
    {
      "statusId": 0,
      "statusCode": "example_statusCode",
      "statusLabel": "example_statusLabel",
      "orderCount": 0,
      "totalValue": 0,
      "percentage": 0
    }
  ],
  "currency": "example_currency"
}

Request example

GET /bff/dashboard/orders-by-status

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/orders-by-status?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