BizKitHub
DocsAPI ReferenceOrganisation/bff/organisation-ai/usage/summary
getOrganisationAdmin BFF

/bff/organisation-ai/usage/summary

Rolling-window totals of AI prompts executed for the authenticated organisation: token consumption, USD cost priced against the historical ai__model_price row effective on each prompt's date, and prompt count for the last 1 / 7 / 30 / 365 days. orgCurrency envelope carries today's USD → default currency rate so the client can convert with a single multiplication instead of round-tripping per row.

OrganisationgetBffOrganisation-aiUsageSummary

Parameters

No parameters required

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

Response schema

1 status code documented

200Success
windowsobjectRequired
dayobjectRequired
tokensnumberRequired
costnumberRequired
countnumberRequired
weekobjectRequired
tokensnumberRequired
costnumberRequired
countnumberRequired
monthobjectRequired
tokensnumberRequired
costnumberRequired
countnumberRequired
yearobjectRequired
tokensnumberRequired
costnumberRequired
countnumberRequired
orgCurrencyobjectRequired
codestringRequired

ISO 4217 code of the organisation default currency (e.g. "CZK").

ratenumberRequired

Multiplier: usd × rate = amount in code.

rateDatestringRequired

YYYY-MM-DD of the underlying fixing.

Response example

application/json
{
  "windows": {
    "day": {
      "tokens": 0,
      "cost": 0,
      "count": 0
    },
    "week": {
      "tokens": 0,
      "cost": 0,
      "count": 0
    },
    "month": {
      "tokens": 0,
      "cost": 0,
      "count": 0
    },
    "year": {
      "tokens": 0,
      "cost": 0,
      "count": 0
    }
  },
  "orgCurrency": {
    "code": "example_code",
    "rate": 0,
    "rateDate": "example_rateDate"
  }
}

Request example

GET /bff/organisation-ai/usage/summary

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