Parameters
No parameters required
This endpoint takes no path, query, header or body parameters.
/bff/admin/usage-overview
Returns aggregated platform usage for the internal admin dashboard: (a) system-wide totals per calendar month for the last 12 months, (b) one row per organisation with lifetime and current-month totals of API requests, transactional emails, orders and AI tokens, sorted by lifetime API requests descending, and (c) an estimated internal cost in CZK derived from a Phase-A cost model. The cost model per-unit prices are echoed back in costModel and flagged with isEstimate: true — this is a rough order-of-magnitude figure, not real billing. Requires internal admin membership.
AdmingetBffAdminUsage-overview
Response schema
1 status code documented
200Success
systemMonthlyobject[]RequiredEach array item:
periodStartstringRequiredFirst day of the calendar month (YYYY-MM-DD).
ordersCountnumberRequiredOrders created platform-wide in the month.
emailsCountnumberRequiredTransactional emails sent+received platform-wide in the month.
aiTokensCountnumberRequiredAI tokens consumed platform-wide in the month.
apiRequestsCountnumberRequiredAuthenticated public API requests platform-wide in the month.
estimatedCostCzknumberRequiredEstimated internal cost in CZK for the month (Phase-A model).
perOrgobject[]RequiredEach array item:
organisationIdnumberRequiredInternal organisation ID.
namestringRequiredOrganisation display name.
slugstringRequiredOrganisation slug.
emojistring | nullRequiredOrganisation emoji icon.
One of 2:
Variant 1
string
Variant 2
null
lifetimeobjectRequiredordersCountnumberRequiredemailsCountnumberRequiredaiTokensCountnumberRequiredapiRequestsCountnumberRequiredestimatedCostCzknumberRequiredcurrentMonthobjectRequiredordersCountnumberRequiredemailsCountnumberRequiredaiTokensCountnumberRequiredapiRequestsCountnumberRequiredestimatedCostCzknumberRequiredtotalsobjectRequiredcurrentMonthobjectRequiredordersCountnumberRequiredemailsCountnumberRequiredaiTokensCountnumberRequiredapiRequestsCountnumberRequiredestimatedCostCzknumberRequiredlifetimeobjectRequiredordersCountnumberRequiredemailsCountnumberRequiredaiTokensCountnumberRequiredapiRequestsCountnumberRequiredestimatedCostCzknumberRequiredcostModelobjectRequiredperApiRequestCzknumberRequiredCZK cost estimate per authenticated API request.
perEmailCzknumberRequiredCZK cost estimate per transactional email.
perOrderCzknumberRequiredCZK cost estimate per order created.
perAiTokenCzknumberRequiredCZK cost estimate per AI token consumed.
isEstimatebooleanRequiredTrue while running on the Phase-A placeholder model.
Response example
application/json{
"systemMonthly": [
{
"periodStart": "example_periodStart",
"ordersCount": 0,
"emailsCount": 0,
"aiTokensCount": 0,
"apiRequestsCount": 0,
"estimatedCostCzk": 0
}
],
"perOrg": [
{
"organisationId": 0,
"name": "example_name",
"slug": "example_slug",
"lifetime": {
"ordersCount": 0,
"emailsCount": 0,
"aiTokensCount": 0,
"apiRequestsCount": 0,
"estimatedCostCzk": 0
},
"currentMonth": {
"ordersCount": 0,
"emailsCount": 0,
"aiTokensCount": 0,
"apiRequestsCount": 0,
"estimatedCostCzk": 0
}
}
],
"totals": {
"currentMonth": {
"ordersCount": 0,
"emailsCount": 0,
"aiTokensCount": 0,
"apiRequestsCount": 0,
"estimatedCostCzk": 0
},
"lifetime": {
"ordersCount": 0,
"emailsCount": 0,
"aiTokensCount": 0,
"apiRequestsCount": 0,
"estimatedCostCzk": 0
}
},
"costModel": {
"perApiRequestCzk": 0,
"perEmailCzk": 0,
"perOrderCzk": 0,
"perAiTokenCzk": 0,
"isEstimate": false
}
}Request example
GET /bff/admin/usage-overview
curl -X GET "https://api.bizkithub.com/bff/admin/usage-overview" \
-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.