BizKitHub
DocsAPI ReferenceUsage/bff/usage/summary
getUsageAdmin BFF

/bff/usage/summary

Returns a comprehensive usage summary for the authenticated organisation including storage consumption, AI token usage by model, email delivery statistics, and entity counts.

UsagegetBffUsageSummary

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
storageobjectRequired

File storage usage breakdown.

totalBytesnumberRequired

Total storage used in bytes.

categoriesobject[]Required

Breakdown of storage by file category.

Each array item:
tagstringRequired

Storage category tag (e.g. "image", "document").

countnumberRequired

Number of files in this category.

sizeBytesnumberRequired

Total size of files in this category, in bytes.

aiTokensobjectRequired

AI token consumption statistics.

totalTokensnumberRequired

Total AI tokens consumed.

totalCostnumberRequired

Total estimated cost of AI token usage.

byModelobjectRequired

Token usage grouped by AI model.

emailsobjectRequired

Email delivery statistics.

totalnumberRequired

Total emails processed.

sentnumberRequired

Successfully delivered emails.

failednumberRequired

Emails that failed to send.

pendingnumberRequired

Emails queued for delivery.

countsobjectRequired

Entity counts across the organisation.

productsnumberRequired

Total products in the organisation.

ordersnumberRequired

Total orders.

customersnumberRequired

Total customer contacts.

membersnumberRequired

Active organisation members.

invoicesnumberRequired

Total invoices.

formsnumberRequired

Total forms.

vouchersnumberRequired

Total vouchers.

Response example

application/json
{
  "storage": {
    "totalBytes": 0,
    "categories": [
      {
        "tag": "example_tag",
        "count": 0,
        "sizeBytes": 0
      }
    ]
  },
  "aiTokens": {
    "totalTokens": 0,
    "totalCost": 0,
    "byModel": {}
  },
  "emails": {
    "total": 0,
    "sent": 0,
    "failed": 0,
    "pending": 0
  },
  "counts": {
    "products": 0,
    "orders": 0,
    "customers": 0,
    "members": 0,
    "invoices": 0,
    "forms": 0,
    "vouchers": 0
  }
}

Request example

GET /bff/usage/summary

get
curl -X GET "https://api.bizkithub.com/bff/usage/summary" \
  -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