BokaMera.API.Host

SuperAdminAssistantUsageQuery

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
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.

// @ts-nocheck

export class AssistantUsageMeter
{
    /** @description Tokens consumed within the current rolling window. */
    // @ApiMember(Description="Tokens consumed within the current rolling window.")
    public TokensUsed: number;

    /** @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.")
    public TokenLimit: number;

    /** @description Tokens remaining before the limit is reached (never negative). */
    // @ApiMember(Description="Tokens remaining before the limit is reached (never negative).")
    public TokensRemaining: number;

    /** @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.")
    public PercentUsed: number;

    /** @description True while the company is still below its token limit. */
    // @ApiMember(Description="True while the company is still below its token limit.")
    public IsWithinBudget: boolean;

    public constructor(init?: Partial<AssistantUsageMeter>) { (Object as any).assign(this, init); }
}

export class SuperAdminAssistantUsage
{
    /** @description The company the usage applies to. */
    // @ApiMember(Description="The company the usage applies to.")
    public CompanyId: string;

    /** @description The company's name. */
    // @ApiMember(Description="The company's name.")
    public CompanyName: string;

    /** @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.")
    public AiChat?: AssistantUsageMeter;

    /** @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.")
    public Mcp?: AssistantUsageMeter;

    public constructor(init?: Partial<SuperAdminAssistantUsage>) { (Object as any).assign(this, init); }
}

export class SuperAdminAssistantUsageQueryResponse
{
    /** @description Number of companies skipped. */
    // @ApiMember(Description="Number of companies skipped.")
    public Offset: number;

    /** @description Total number of companies matching the filter. */
    // @ApiMember(Description="Total number of companies matching the filter.")
    public Total: number;

    /** @description Length of the rolling usage window, in days. */
    // @ApiMember(Description="Length of the rolling usage window, in days.")
    public WindowDays: number;

    /** @description Usage for the requested page of companies. */
    // @ApiMember(Description="Usage for the requested page of companies.")
    public Results: SuperAdminAssistantUsage[] = [];

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SuperAdminAssistantUsageQueryResponse>) { (Object as any).assign(this, init); }
}

// @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")
export class SuperAdminAssistantUsageQuery
{
    /** @description Filter on company name. Case-insensitive substring match. */
    // @ApiMember(DataType="string", Description="Filter on company name. Case-insensitive substring match.", ParameterType="query")
    public Search?: string;

    /** @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")
    public CompanyId?: string;

    /** @description Number of companies to skip. */
    // @ApiMember(DataType="integer", Description="Number of companies to skip.", ParameterType="query")
    public Skip?: number;

    /** @description Number of companies to return. Capped server-side. */
    // @ApiMember(DataType="integer", Description="Number of companies to return. Capped server-side.", ParameterType="query")
    public Take?: number;

    public constructor(init?: Partial<SuperAdminAssistantUsageQuery>) { (Object as any).assign(this, init); }
}

TypeScript SuperAdminAssistantUsageQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}