| 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. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type AssistantUsageMeter() =
///<summary>
///Tokens consumed within the current rolling window.
///</summary>
[<ApiMember(Description="Tokens consumed within the current rolling window.")>]
member val TokensUsed:Int64 = new Int64() with get,set
///<summary>
///The company's token limit for the window. Zero or less means no cap is applied.
///</summary>
[<ApiMember(Description="The company's token limit for the window. Zero or less means no cap is applied.")>]
member val TokenLimit:Int32 = new Int32() with get,set
///<summary>
///Tokens remaining before the limit is reached (never negative).
///</summary>
[<ApiMember(Description="Tokens remaining before the limit is reached (never negative).")>]
member val TokensRemaining:Int64 = new Int64() with get,set
///<summary>
///Share of the limit consumed, as a percentage. Zero when no cap is applied.
///</summary>
[<ApiMember(Description="Share of the limit consumed, as a percentage. Zero when no cap is applied.")>]
member val PercentUsed:Double = new Double() with get,set
///<summary>
///True while the company is still below its token limit.
///</summary>
[<ApiMember(Description="True while the company is still below its token limit.")>]
member val IsWithinBudget:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type SuperAdminAssistantUsage() =
///<summary>
///The company the usage applies to.
///</summary>
[<ApiMember(Description="The company the usage applies to.")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The company's name.
///</summary>
[<ApiMember(Description="The company's name.")>]
member val CompanyName:String = null with get,set
///<summary>
///Token budget for the admin portal AI assistant. Null when it could not be read.
///</summary>
[<ApiMember(Description="Token budget for the admin portal AI assistant. Null when it could not be read.")>]
member val AiChat:AssistantUsageMeter = null with get,set
///<summary>
///Token budget for the public MCP server. Null when it could not be read.
///</summary>
[<ApiMember(Description="Token budget for the public MCP server. Null when it could not be read.")>]
member val Mcp:AssistantUsageMeter = null with get,set
[<AllowNullLiteral>]
type SuperAdminAssistantUsageQueryResponse() =
///<summary>
///Number of companies skipped.
///</summary>
[<ApiMember(Description="Number of companies skipped.")>]
member val Offset:Int32 = new Int32() with get,set
///<summary>
///Total number of companies matching the filter.
///</summary>
[<ApiMember(Description="Total number of companies matching the filter.")>]
member val Total:Int32 = new Int32() with get,set
///<summary>
///Length of the rolling usage window, in days.
///</summary>
[<ApiMember(Description="Length of the rolling usage window, in days.")>]
member val WindowDays:Int32 = new Int32() with get,set
///<summary>
///Usage for the requested page of companies.
///</summary>
[<ApiMember(Description="Usage for the requested page of companies.")>]
member val Results:ResizeArray<SuperAdminAssistantUsage> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<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")>]
[<AllowNullLiteral>]
type SuperAdminAssistantUsageQuery() =
///<summary>
///Filter on company name. Case-insensitive substring match.
///</summary>
[<ApiMember(DataType="string", Description="Filter on company name. Case-insensitive substring match.", ParameterType="query")>]
member val Search:String = null with get,set
///<summary>
///Return only this company. Takes precedence over Search when both are set.
///</summary>
[<ApiMember(DataType="string", Description="Return only this company. Takes precedence over Search when both are set.", ParameterType="query")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Number of companies to skip.
///</summary>
[<ApiMember(DataType="integer", Description="Number of companies to skip.", ParameterType="query")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Number of companies to return. Capped server-side.
///</summary>
[<ApiMember(DataType="integer", Description="Number of companies to return. Capped server-side.", ParameterType="query")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
F# 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"}}}