| 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. |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AssistantUsageMeter
{
///<summary>
///Tokens consumed within the current rolling window.
///</summary>
[ApiMember(Description="Tokens consumed within the current rolling window.")]
public virtual long TokensUsed { 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.")]
public virtual int TokenLimit { get; set; }
///<summary>
///Tokens remaining before the limit is reached (never negative).
///</summary>
[ApiMember(Description="Tokens remaining before the limit is reached (never negative).")]
public virtual long TokensRemaining { 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.")]
public virtual double PercentUsed { 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.")]
public virtual bool IsWithinBudget { get; set; }
}
public partial class SuperAdminAssistantUsage
{
///<summary>
///The company the usage applies to.
///</summary>
[ApiMember(Description="The company the usage applies to.")]
public virtual Guid CompanyId { get; set; }
///<summary>
///The company's name.
///</summary>
[ApiMember(Description="The company's name.")]
public virtual string CompanyName { 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.")]
public virtual AssistantUsageMeter? AiChat { 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.")]
public virtual AssistantUsageMeter? Mcp { 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("IsAuthenticated")]
public partial class 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")]
public virtual string? Search { 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")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///Number of companies to skip.
///</summary>
[ApiMember(DataType="integer", Description="Number of companies to skip.", ParameterType="query")]
public virtual int? Skip { 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")]
public virtual int? Take { get; set; }
}
public partial class SuperAdminAssistantUsageQueryResponse
{
///<summary>
///Number of companies skipped.
///</summary>
[ApiMember(Description="Number of companies skipped.")]
public virtual int Offset { get; set; }
///<summary>
///Total number of companies matching the filter.
///</summary>
[ApiMember(Description="Total number of companies matching the filter.")]
public virtual int Total { get; set; }
///<summary>
///Length of the rolling usage window, in days.
///</summary>
[ApiMember(Description="Length of the rolling usage window, in days.")]
public virtual int WindowDays { get; set; }
///<summary>
///Usage for the requested page of companies.
///</summary>
[ApiMember(Description="Usage for the requested page of companies.")]
public virtual List<SuperAdminAssistantUsage> Results { get; set; } = [];
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
C# 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"}}}