Load test counter instances

Last Update: 12/5/2016

api-version = 1.0

If you haven't already, look at the information on getting started with these APIs.

Get a list of counter instances

GET https://{account}.vsclt.VisualStudio.com/_apis/clt/testruns/{testrunId}/counterinstances

Returns a list of counter instances that are being monitored by the load test run.

Parameter Type Notes
URL
account string Visual Studio Team Services account.
testrunid string The test run identifier.
Query
groupNames string Comma separated names of counter groups, such as 'Application', 'Performance' and 'Throughput'

Sample request

GET https://fabrikam.vsclt.visualstudio.com/_apis/clt/testRuns/5c9dc626-44aa-410b-8f75-2929dd330397/CounterInstances?groupNames=Performance%2CThroughput%2CApplication

Sample response

Status code: 200
{
  "count": 8,
  "value": [
    {
      "counterInstanceId": "Els~-2020039322",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Test",
      "counterName": "Avg. Test Time",
      "counterUnits": "sec",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": false,
      "partOfCounterGroups": [
        "Performance"
      ]
    },
    {
      "counterInstanceId": "Els~-1543222480",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Page",
      "counterName": "Avg. Page Time",
      "counterUnits": "sec",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": false,
      "partOfCounterGroups": [
        "Performance"
      ]
    },
    {
      "counterInstanceId": "Els~-1854500553",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Request",
      "counterName": "Avg. Response Time",
      "counterUnits": "sec",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": false,
      "partOfCounterGroups": [
        "Performance"
      ]
    },
    {
      "counterInstanceId": "Els~-1828439162",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Scenario",
      "counterName": "User Load",
      "counterUnits": "vusers",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": true,
      "partOfCounterGroups": [
        "Performance",
        "Throughput",
        "Application"
      ]
    },
    {
      "counterInstanceId": "Els~-46855952",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Test",
      "counterName": "Tests/Sec",
      "counterUnits": "-",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": false,
      "partOfCounterGroups": [
        "Throughput"
      ]
    },
    {
      "counterInstanceId": "Els~424850519",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Page",
      "counterName": "Pages/Sec",
      "counterUnits": "-",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": false,
      "partOfCounterGroups": [
        "Throughput"
      ]
    },
    {
      "counterInstanceId": "Els~1226640887",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Request",
      "counterName": "Requests/Sec",
      "counterUnits": "-",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": false,
      "partOfCounterGroups": [
        "Throughput"
      ]
    },
    {
      "counterInstanceId": "Els~-1525400324",
      "machineName": "ELSCONTROLLER",
      "categoryName": "LoadTest:Errors",
      "counterName": "Errors/Sec",
      "counterUnits": "-",
      "instanceName": "_Total",
      "uniqueName": null,
      "isPreselectedCounter": false,
      "partOfCounterGroups": [
        "Throughput"
      ]
    }
  ]
}