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.

"use strict";
export class AssistantUsageMeter {
    /** @param {{TokensUsed?:number,TokenLimit?:number,TokensRemaining?:number,PercentUsed?:number,IsWithinBudget?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Tokens consumed within the current rolling window. */
    TokensUsed;
    /**
     * @type {number}
     * @description The company's token limit for the window. Zero or less means no cap is applied. */
    TokenLimit;
    /**
     * @type {number}
     * @description Tokens remaining before the limit is reached (never negative). */
    TokensRemaining;
    /**
     * @type {number}
     * @description Share of the limit consumed, as a percentage. Zero when no cap is applied. */
    PercentUsed;
    /**
     * @type {boolean}
     * @description True while the company is still below its token limit. */
    IsWithinBudget;
}
export class SuperAdminAssistantUsage {
    /** @param {{CompanyId?:string,CompanyName?:string,AiChat?:AssistantUsageMeter,Mcp?:AssistantUsageMeter}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company the usage applies to. */
    CompanyId;
    /**
     * @type {string}
     * @description The company's name. */
    CompanyName;
    /**
     * @type {?AssistantUsageMeter}
     * @description Token budget for the admin portal AI assistant. Null when it could not be read. */
    AiChat;
    /**
     * @type {?AssistantUsageMeter}
     * @description Token budget for the public MCP server. Null when it could not be read. */
    Mcp;
}
export class SuperAdminAssistantUsageQueryResponse {
    /** @param {{Offset?:number,Total?:number,WindowDays?:number,Results?:SuperAdminAssistantUsage[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Number of companies skipped. */
    Offset;
    /**
     * @type {number}
     * @description Total number of companies matching the filter. */
    Total;
    /**
     * @type {number}
     * @description Length of the rolling usage window, in days. */
    WindowDays;
    /**
     * @type {SuperAdminAssistantUsage[]}
     * @description Usage for the requested page of companies. */
    Results = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SuperAdminAssistantUsageQuery {
    /** @param {{Search?:string,CompanyId?:string,Skip?:number,Take?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description Filter on company name. Case-insensitive substring match. */
    Search;
    /**
     * @type {?string}
     * @description Return only this company. Takes precedence over Search when both are set. */
    CompanyId;
    /**
     * @type {?number}
     * @description Number of companies to skip. */
    Skip;
    /**
     * @type {?number}
     * @description Number of companies to return. Capped server-side. */
    Take;
}

JavaScript 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
		}
	}
}