| Requires the role: | superadmin |
| GET | /superadmin/assistant/usage | List AI assistant and MCP token usage per company | Returns, for a page of companies, how many tokens each has consumed in the current rolling window against its configured limit — separately for the admin AI assistant and for the public MCP server. Usage is read from the rolling-window store, so only the current window is available; there is no history. Ordering is by company name, because usage is not stored in a queryable form and cannot be sorted across pages. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Search | query | string | No | Filter on company name. Case-insensitive substring match. |
| CompanyId | query | string | No | Return only this company. Takes precedence over Search when both are set. |
| Skip | query | integer | No | Number of companies to skip. |
| Take | query | integer | No | Number of companies to return. Capped server-side. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | Number of companies skipped. |
| Total | form | int | No | Total number of companies matching the filter. |
| WindowDays | form | int | No | Length of the rolling usage window, in days. |
| Results | form | List<SuperAdminAssistantUsage> | Yes | Usage for the requested page of companies. |
| ResponseStatus | form | ResponseStatus | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | The company the usage applies to. |
| CompanyName | form | string | Yes | The company's name. |
| AiChat | form | AssistantUsageMeter | No | Token budget for the admin portal AI assistant. Null when it could not be read. |
| Mcp | form | AssistantUsageMeter | No | Token budget for the public MCP server. Null when it could not be read. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TokensUsed | form | long | No | Tokens consumed within the current rolling window. |
| TokenLimit | form | int | No | The company's token limit for the window. Zero or less means no cap is applied. |
| TokensRemaining | form | long | No | Tokens remaining before the limit is reached (never negative). |
| PercentUsed | form | double | No | Share of the limit consumed, as a percentage. Zero when no cap is applied. |
| IsWithinBudget | form | bool | No | True while the company is still below its token limit. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/assistant/usage HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"WindowDays":0,"Results":[{"CompanyName":"String","AiChat":{"TokensUsed":0,"TokenLimit":0,"TokensRemaining":0,"PercentUsed":0,"IsWithinBudget":false},"Mcp":{"TokensUsed":0,"TokenLimit":0,"TokensRemaining":0,"PercentUsed":0,"IsWithinBudget":false}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}