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

/bff/organisation-ai/usage/analytics

Aggregated breakdowns of AI prompt spend: by model, by payer (organisation via BYOK vs. BizKitHub via shared key), daily 30-day time series, and the top 10 most expensive individual prompts. Powers the "Analytika" tab under settings → AI.

OrganisationgetBffOrganisation-aiUsageAnalytics

Parameters

No parameters required

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

Response schema

1 status code documented

200Success
byModelobject[]Required

Spend broken down per AI model, ordered by cost desc.

Each array item:
modelstringRequired
promptCountnumberRequired
tokensnumberRequired
costnumberRequired
avgCostPerPromptnumberRequired

cost / promptCount, 0 when no prompts.

byPayerobjectRequired

Spend split between calls billed to this organisation (BYOK) vs. subsidised by BizKitHub.

organisationobjectRequired
promptCountnumberRequired
tokensnumberRequired
costnumberRequired
bizkitobjectRequired
promptCountnumberRequired
tokensnumberRequired
costnumberRequired
dailyobject[]Required

Daily buckets for the last 30 days. Only days with at least one prompt appear.

Each array item:
datestringRequired

YYYY-MM-DD.

promptCountnumberRequired
tokensnumberRequired
costnumberRequired
topExpensiveobject[]Required

Top 10 most expensive individual prompts, ordered by cost desc.

Each array item:
idstringRequired
questionstringRequired

Prompt preview (truncated to 200 characters).

modelstringRequired
tokensnumberRequired
costnumberRequired
payer"organisation" | "bizkit"Required
insertedDatestringRequired
promptTypesobject[]Required

Top 30 prompt templates by total cost, grouped by normalised first line.

Each array item:
patternstringRequired

Normalised first line of the prompt — quoted strings replaced with , ISO dates with , 20+ char identifiers with , 2+ digit numbers with #. Consolidates near-duplicate prompts that differ only in embedded data (e.g. translation prompts across target languages).

promptCountnumberRequired
tokensnumberRequired
costnumberRequired
avgCostPerPromptnumberRequired
lastUsedDatestringRequired
sampleIdstringRequired

ai__question.id of one representative row in this group.

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
{
  "byModel": [
    {
      "model": "example_model",
      "promptCount": 0,
      "tokens": 0,
      "cost": 0,
      "avgCostPerPrompt": 0
    }
  ],
  "byPayer": {
    "organisation": {
      "promptCount": 0,
      "tokens": 0,
      "cost": 0
    },
    "bizkit": {
      "promptCount": 0,
      "tokens": 0,
      "cost": 0
    }
  },
  "daily": [
    {
      "date": "example_date",
      "promptCount": 0,
      "tokens": 0,
      "cost": 0
    }
  ],
  "topExpensive": [
    {
      "id": "example_id",
      "question": "example_question",
      "model": "example_model",
      "tokens": 0,
      "cost": 0,
      "insertedDate": "example_insertedDate"
    }
  ],
  "promptTypes": [
    {
      "pattern": "example_pattern",
      "promptCount": 0,
      "tokens": 0,
      "cost": 0,
      "avgCostPerPrompt": 0,
      "lastUsedDate": "example_lastUsedDate",
      "sampleId": "example_sampleId"
    }
  ],
  "orgCurrency": {
    "code": "example_code",
    "rate": 0,
    "rateDate": "example_rateDate"
  }
}

Request example

GET /bff/organisation-ai/usage/analytics

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