| 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. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AssistantUsageMeter:
# @ApiMember(Description="Tokens consumed within the current rolling window.")
tokens_used: int = 0
"""
Tokens consumed within the current rolling window.
"""
# @ApiMember(Description="The company's token limit for the window. Zero or less means no cap is applied.")
token_limit: int = 0
"""
The company's token limit for the window. Zero or less means no cap is applied.
"""
# @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
tokens_remaining: int = 0
"""
Tokens remaining before the limit is reached (never negative).
"""
# @ApiMember(Description="Share of the limit consumed, as a percentage. Zero when no cap is applied.")
percent_used: float = 0.0
"""
Share of the limit consumed, as a percentage. Zero when no cap is applied.
"""
# @ApiMember(Description="True while the company is still below its token limit.")
is_within_budget: bool = False
"""
True while the company is still below its token limit.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SuperAdminAssistantUsage:
# @ApiMember(Description="The company the usage applies to.")
company_id: Optional[str] = None
"""
The company the usage applies to.
"""
# @ApiMember(Description="The company's name.")
company_name: Optional[str] = None
"""
The company's name.
"""
# @ApiMember(Description="Token budget for the admin portal AI assistant. Null when it could not be read.")
ai_chat: Optional[AssistantUsageMeter] = None
"""
Token budget for the admin portal AI assistant. Null when it could not be read.
"""
# @ApiMember(Description="Token budget for the public MCP server. Null when it could not be read.")
mcp: Optional[AssistantUsageMeter] = None
"""
Token budget for the public MCP server. Null when it could not be read.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SuperAdminAssistantUsageQueryResponse:
# @ApiMember(Description="Number of companies skipped.")
offset: int = 0
"""
Number of companies skipped.
"""
# @ApiMember(Description="Total number of companies matching the filter.")
total: int = 0
"""
Total number of companies matching the filter.
"""
# @ApiMember(Description="Length of the rolling usage window, in days.")
window_days: int = 0
"""
Length of the rolling usage window, in days.
"""
# @ApiMember(Description="Usage for the requested page of companies.")
results: List[SuperAdminAssistantUsage] = field(default_factory=list)
"""
Usage for the requested page of companies.
"""
response_status: Optional[ResponseStatus] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SuperAdminAssistantUsageQuery:
# @ApiMember(DataType="string", Description="Filter on company name. Case-insensitive substring match.", ParameterType="query")
search: Optional[str] = None
"""
Filter on company name. Case-insensitive substring match.
"""
# @ApiMember(DataType="string", Description="Return only this company. Takes precedence over Search when both are set.", ParameterType="query")
company_id: Optional[str] = None
"""
Return only this company. Takes precedence over Search when both are set.
"""
# @ApiMember(DataType="integer", Description="Number of companies to skip.", ParameterType="query")
skip: Optional[int] = None
"""
Number of companies to skip.
"""
# @ApiMember(DataType="integer", Description="Number of companies to return. Capped server-side.", ParameterType="query")
take: Optional[int] = None
"""
Number of companies to return. Capped server-side.
"""
Python SuperAdminAssistantUsageQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}