Skip to main content

getRoleStatistics

client.swarm.getRoleStatistics(swarmId: string): Promise<SwarmRoleStatistics[]>

Get role statistics for a swarm.

Retrieves statistical information about all roles in a swarm, including assignment counts, utilization rates, and activity metrics. Use this for monitoring role distribution and workload balance.

Parameters

ParameterTypeRequiredDescription
swarmIdstringYesThe unique identifier of the swarm

Returns

Promise<SwarmRoleStatistics[]> — A promise that resolves to an array of SwarmRoleStatistics objects

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.swarm.getRoleStatistics('swarmId');
console.log(result);