| 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. |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class AssistantUsageMeter implements JsonSerializable
{
public function __construct(
/** @description Tokens consumed within the current rolling window. */
// @ApiMember(Description="Tokens consumed within the current rolling window.")
/** @var int */
public int $TokensUsed=0,
/** @description The company's token limit for the window. Zero or less means no cap is applied. */
// @ApiMember(Description="The company's token limit for the window. Zero or less means no cap is applied.")
/** @var int */
public int $TokenLimit=0,
/** @description Tokens remaining before the limit is reached (never negative). */
// @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
/** @var int */
public int $TokensRemaining=0,
/** @description Share of the limit consumed, as a percentage. Zero when no cap is applied. */
// @ApiMember(Description="Share of the limit consumed, as a percentage. Zero when no cap is applied.")
/** @var float */
public float $PercentUsed=0.0,
/** @description True while the company is still below its token limit. */
// @ApiMember(Description="True while the company is still below its token limit.")
/** @var bool|null */
public ?bool $IsWithinBudget=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['TokensUsed'])) $this->TokensUsed = $o['TokensUsed'];
if (isset($o['TokenLimit'])) $this->TokenLimit = $o['TokenLimit'];
if (isset($o['TokensRemaining'])) $this->TokensRemaining = $o['TokensRemaining'];
if (isset($o['PercentUsed'])) $this->PercentUsed = $o['PercentUsed'];
if (isset($o['IsWithinBudget'])) $this->IsWithinBudget = $o['IsWithinBudget'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->TokensUsed)) $o['TokensUsed'] = $this->TokensUsed;
if (isset($this->TokenLimit)) $o['TokenLimit'] = $this->TokenLimit;
if (isset($this->TokensRemaining)) $o['TokensRemaining'] = $this->TokensRemaining;
if (isset($this->PercentUsed)) $o['PercentUsed'] = $this->PercentUsed;
if (isset($this->IsWithinBudget)) $o['IsWithinBudget'] = $this->IsWithinBudget;
return empty($o) ? new class(){} : $o;
}
}
class SuperAdminAssistantUsage implements JsonSerializable
{
public function __construct(
/** @description The company the usage applies to. */
// @ApiMember(Description="The company the usage applies to.")
/** @var string */
public string $CompanyId='',
/** @description The company's name. */
// @ApiMember(Description="The company's name.")
/** @var string */
public string $CompanyName='',
/** @description Token budget for the admin portal AI assistant. Null when it could not be read. */
// @ApiMember(Description="Token budget for the admin portal AI assistant. Null when it could not be read.")
/** @var AssistantUsageMeter|null */
public ?AssistantUsageMeter $AiChat=null,
/** @description Token budget for the public MCP server. Null when it could not be read. */
// @ApiMember(Description="Token budget for the public MCP server. Null when it could not be read.")
/** @var AssistantUsageMeter|null */
public ?AssistantUsageMeter $Mcp=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['CompanyName'])) $this->CompanyName = $o['CompanyName'];
if (isset($o['AiChat'])) $this->AiChat = JsonConverters::from('AssistantUsageMeter', $o['AiChat']);
if (isset($o['Mcp'])) $this->Mcp = JsonConverters::from('AssistantUsageMeter', $o['Mcp']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->CompanyName)) $o['CompanyName'] = $this->CompanyName;
if (isset($this->AiChat)) $o['AiChat'] = JsonConverters::to('AssistantUsageMeter', $this->AiChat);
if (isset($this->Mcp)) $o['Mcp'] = JsonConverters::to('AssistantUsageMeter', $this->Mcp);
return empty($o) ? new class(){} : $o;
}
}
class SuperAdminAssistantUsageQueryResponse implements JsonSerializable
{
public function __construct(
/** @description Number of companies skipped. */
// @ApiMember(Description="Number of companies skipped.")
/** @var int */
public int $Offset=0,
/** @description Total number of companies matching the filter. */
// @ApiMember(Description="Total number of companies matching the filter.")
/** @var int */
public int $Total=0,
/** @description Length of the rolling usage window, in days. */
// @ApiMember(Description="Length of the rolling usage window, in days.")
/** @var int */
public int $WindowDays=0,
/** @description Usage for the requested page of companies. */
// @ApiMember(Description="Usage for the requested page of companies.")
/** @var array<SuperAdminAssistantUsage>|null */
public ?array $Results=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Offset'])) $this->Offset = $o['Offset'];
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['WindowDays'])) $this->WindowDays = $o['WindowDays'];
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('SuperAdminAssistantUsage', $o['Results']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Offset)) $o['Offset'] = $this->Offset;
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->WindowDays)) $o['WindowDays'] = $this->WindowDays;
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('SuperAdminAssistantUsage', $this->Results);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @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")
class SuperAdminAssistantUsageQuery implements JsonSerializable
{
public function __construct(
/** @description Filter on company name. Case-insensitive substring match. */
// @ApiMember(DataType="string", Description="Filter on company name. Case-insensitive substring match.", ParameterType="query")
/** @var string|null */
public ?string $Search=null,
/** @description Return only this company. Takes precedence over Search when both are set. */
// @ApiMember(DataType="string", Description="Return only this company. Takes precedence over Search when both are set.", ParameterType="query")
/** @var string|null */
public ?string $CompanyId=null,
/** @description Number of companies to skip. */
// @ApiMember(DataType="integer", Description="Number of companies to skip.", ParameterType="query")
/** @var int|null */
public ?int $Skip=null,
/** @description Number of companies to return. Capped server-side. */
// @ApiMember(DataType="integer", Description="Number of companies to return. Capped server-side.", ParameterType="query")
/** @var int|null */
public ?int $Take=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Search'])) $this->Search = $o['Search'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Skip'])) $this->Skip = $o['Skip'];
if (isset($o['Take'])) $this->Take = $o['Take'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Search)) $o['Search'] = $this->Search;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Skip)) $o['Skip'] = $this->Skip;
if (isset($this->Take)) $o['Take'] = $this->Take;
return empty($o) ? new class(){} : $o;
}
}
PHP SuperAdminAssistantUsageQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}