Skip to main content

Virtual User Group Counts

This Eggplant Performance Test Controller REST method gets the number of virtual users in each group, and their total.

If the test is in progress, then the counts returned by this method will include virtual users started during the test run, for example using the Add Virtual Users REST method. Otherwise, the virtual user counts correspond to the test as defined in Eggplant Performance Studio.

URL

/test_controller/api/1.0/<workspace>/<project>/<test>/virtual_user_group_counts

HTTP Method

GET: Gets the number of virtual users in each group, and their total.

Response Parameters

ParameterTypeDescription
total_countIntegerThe total number of virtual users, across all groups.
groupsObjectKeys are the virtual user group names, and values are the number of virtual users in that group.

Example Request

http://localhost:5001/test_controller/api/1.0/Demo%20Workspace/Demo/demoScript/virtual_user_group_counts

Example Response

{
"total_count": 6,
"groups": {
"Group A": 2,
"Group B": 4
}
}