| 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 Foundation
import ServiceStack
// @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")
public class SuperAdminAssistantUsageQuery : Codable
{
/**
* Filter on company name. Case-insensitive substring match.
*/
// @ApiMember(DataType="string", Description="Filter on company name. Case-insensitive substring match.", ParameterType="query")
public var search:String
/**
* 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")
public var companyId:String?
/**
* Number of companies to skip.
*/
// @ApiMember(DataType="integer", Description="Number of companies to skip.", ParameterType="query")
public var skip:Int?
/**
* Number of companies to return. Capped server-side.
*/
// @ApiMember(DataType="integer", Description="Number of companies to return. Capped server-side.", ParameterType="query")
public var take:Int?
required public init(){}
}
public class SuperAdminAssistantUsageQueryResponse : Codable
{
/**
* Number of companies skipped.
*/
// @ApiMember(Description="Number of companies skipped.")
public var offset:Int
/**
* Total number of companies matching the filter.
*/
// @ApiMember(Description="Total number of companies matching the filter.")
public var total:Int
/**
* Length of the rolling usage window, in days.
*/
// @ApiMember(Description="Length of the rolling usage window, in days.")
public var windowDays:Int
/**
* Usage for the requested page of companies.
*/
// @ApiMember(Description="Usage for the requested page of companies.")
public var results:[SuperAdminAssistantUsage] = []
public var responseStatus:ResponseStatus
required public init(){}
}
public class SuperAdminAssistantUsage : Codable
{
/**
* The company the usage applies to.
*/
// @ApiMember(Description="The company the usage applies to.")
public var companyId:String
/**
* The company's name.
*/
// @ApiMember(Description="The company's name.")
public var companyName:String
/**
* 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.")
public var aiChat:AssistantUsageMeter
/**
* 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.")
public var mcp:AssistantUsageMeter
required public init(){}
}
public class AssistantUsageMeter : Codable
{
/**
* Tokens consumed within the current rolling window.
*/
// @ApiMember(Description="Tokens consumed within the current rolling window.")
public var tokensUsed:Int
/**
* 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.")
public var tokenLimit:Int
/**
* Tokens remaining before the limit is reached (never negative).
*/
// @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
public var tokensRemaining:Int
/**
* 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.")
public var percentUsed:Double
/**
* True while the company is still below its token limit.
*/
// @ApiMember(Description="True while the company is still below its token limit.")
public var isWithinBudget:Bool
required public init(){}
}
Swift SuperAdminAssistantUsageQuery DTOs
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"}}}