| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@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")
open class SuperAdminAssistantUsageQuery
{
/**
* Filter on company name. Case-insensitive substring match.
*/
@ApiMember(DataType="string", Description="Filter on company name. Case-insensitive substring match.", ParameterType="query")
open var Search:String? = null
/**
* 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")
open var CompanyId:UUID? = null
/**
* Number of companies to skip.
*/
@ApiMember(DataType="integer", Description="Number of companies to skip.", ParameterType="query")
open var Skip:Int? = null
/**
* Number of companies to return. Capped server-side.
*/
@ApiMember(DataType="integer", Description="Number of companies to return. Capped server-side.", ParameterType="query")
open var Take:Int? = null
}
open class SuperAdminAssistantUsageQueryResponse
{
/**
* Number of companies skipped.
*/
@ApiMember(Description="Number of companies skipped.")
open var Offset:Int? = null
/**
* Total number of companies matching the filter.
*/
@ApiMember(Description="Total number of companies matching the filter.")
open var Total:Int? = null
/**
* Length of the rolling usage window, in days.
*/
@ApiMember(Description="Length of the rolling usage window, in days.")
open var WindowDays:Int? = null
/**
* Usage for the requested page of companies.
*/
@ApiMember(Description="Usage for the requested page of companies.")
open var Results:ArrayList<SuperAdminAssistantUsage> = ArrayList<SuperAdminAssistantUsage>()
open var ResponseStatus:ResponseStatus? = null
}
open class SuperAdminAssistantUsage
{
/**
* The company the usage applies to.
*/
@ApiMember(Description="The company the usage applies to.")
open var CompanyId:UUID? = null
/**
* The company's name.
*/
@ApiMember(Description="The company's name.")
open var CompanyName:String? = null
/**
* 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.")
open var AiChat:AssistantUsageMeter? = null
/**
* 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.")
open var Mcp:AssistantUsageMeter? = null
}
open class AssistantUsageMeter
{
/**
* Tokens consumed within the current rolling window.
*/
@ApiMember(Description="Tokens consumed within the current rolling window.")
open var TokensUsed:Long? = null
/**
* 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.")
open var TokenLimit:Int? = null
/**
* Tokens remaining before the limit is reached (never negative).
*/
@ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
open var TokensRemaining:Long? = null
/**
* 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.")
open var PercentUsed:Double? = null
/**
* True while the company is still below its token limit.
*/
@ApiMember(Description="True while the company is still below its token limit.")
open var IsWithinBudget:Boolean? = null
}
Kotlin SuperAdminAssistantUsageQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}