bankstract
Api

Owner usage aggregation (admin)

Admin-only. Aggregates audit metadata across all keys owned by `owner` for the current cycle. Powers the dashboard Overview + Usage.

GET
/v1/admin/usage

Query Parameters

owner*Owner

Header Parameters

authorization?string|null

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/admin/usage?owner=string"
{  "owner": "string",  "tier": "string",  "period_parses": 0,  "success_rate": 0,  "monthly_cap": 0,  "overage_parses": 0,  "projected_overage_naira": "string",  "daily": [    {      "date": "string",      "count": 0    }  ]}
{  "error": "string",  "error_class": "string",  "format_version": "string",  "marker_coverage": 0}
{  "error": "string",  "error_class": "string",  "format_version": "string",  "marker_coverage": 0}
{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string",      "input": null,      "ctx": {}    }  ]}

Current billing-period usage GET

Successful parses across the key owner's keys this cycle, the tier cap, and the projected overage in NGN. Failed parses never count.

Operator funnel metrics (admin) GET

Admin-only. The usage-to-paid funnel derived from existing metadata: demo parses, API parses, owners with a key, and active subscriptions. No client tracking.