Analyze License Usage

Important Notice for TestEngine Customers

Starting from ReadyAPI 3.62.0, VirtServer 3.29.0, and TestEngine 1.34.0, SmartBear Product Family has fully deprecated file-based licenses and transitioned to the ID-based SmartBear License Management (SLM) system. Any customers still using file-based licenses must complete their migration to SLM by September 30, 2025.

From October 1, 2025, existing and activated file-based licenses will continue to work for some time. However, SmartBear will no longer generate new file-based licenses or support activation and deactivation of file-based licenses in ReadyAPI, VirtServer, or TestEngine. All new and updated licenses are now issued in SLM only.

All technical support for file-based licenses has now ceased, and SmartBear no longer maintains the file-based licensing system. Any access or service issues will result in service disruptions that we will not be able to restore.

If you have not completed the process of migrating, contact your Account Manager or SmartBear representative today. Our teams are ready to assist you with smooth transition strategies. For additional support, log a request with our SmartBear Support.

For further information and timelines, refer to the File-Based License End-of-Support Policy page.

Your TestEngine license defines the maximum number of test jobs that can run at the same time. When this limit is reached, TestEngine places additional jobs in a queue.

This topic explains how to:

  • Check the number of running and queued jobs

  • See how long jobs wait in the queue before starting

  • View other related details

The following statistics are used to analyze the TestEngine usage:

  • Peak usage — the maximum number of running and queued test jobs for the specified time period.

  • Test jobs — the total number of running and queued test jobs for the specified time period.

  • Current test jobs — the number of running and queued test jobs at the current moment.

  • Wait time — the maximum and average time the test jobs were in a queue during the specified time period.

Get peak usage statistics

Peak usage statistics show how many tests were running simultaneously. TestEngine groups the statistics by hours.

Using API

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/peak[?from=date][&to=date]

from

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine peak usage statistics after this date and time will be retrieved.

Tip

Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

to

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine peak usage statistics before this date and time will be retrieved.

Tip

Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

Authentication

The request must be authenticated by a TestEngine user.

Example
curl

Use the following command line:

curl -u "user:Password" -X GET "http://localhost:8080/api/v1/testjobs/stats/peak?from=2019-06-04T00:00:00Z&to=2019-06-06T00:00:00Z"

In this example:

-u user:Password

Authenticates the request with the user’s credentials.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs/stats/peak"

The endpoint of the request.

from=2019-06-04T00:00:00Z

Date and time. The peak statistics after this time will be retrieved.

to=2019-06-06T00:00:00Z

Date and time. The peak statistics before this time will be retrieved.

ReadyAPI

  1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do that.

    Tip

    You can also create the needed request from scratch.

  2. Select the GET request to the /api/v1/testjobs/stats/peak resource:

    Get peak TestEngine usage statistics: Select a request

  3. Specify the time frame for which you want to get the Audit Log:

    Get peak TestEngine usage statistics: Enter the timeframe

  4. Open the Auth panel.

  5. Select the Basic (Built-in) authorization type.

    Tip

    If you use the same credentials in several requests, use authorization profiles.

  6. Specify user credentials and select the Authenticate pre-emptively option:

    Get peak TestEngine usage statistics: Add authorization

  7. Send the request:

    Get peak TestEngine usage statistics: Send the request

  8. The response will list the Audit Log entries related to the user for the specified period of time:

    Get TestEngine peak usage: View the response

Using Web UI

  1. Go to the home page of TestEngine:

    http://<testengine-host>:<port>/

    For example, if TestEngine is installed on your local machine, and you run it on the default port, use the following link:

    http://localhost:8080/

  2. Go to Statistics:

    Peak usage statistics

The top graph shows the peak usage statistics for the specified period of time. To select another time period, use the controls in the top-left corner:

TestEngine Statistics: Select time period

Get total usage statistics

The total usage statistics show the total number of running or queued test jobs for the specified period of time.

Using API

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/count[?from=date][&to=date]

from

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine usage statistics after this date and time will be retrieved.

Tip

Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

to

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the TestEngine usage statistics before this date and time will be retrieved.

Tip

Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

Authentication

The request must be authenticated by a TestEngine user.

Example
curl

Use the following command line:

curl -u "user:Password" -X GET "http://localhost:8080/api/v1/testjobs/stats/count?from=2019-06-04T00:00:00Z&to=2019-06-06T00:00:00Z"

In this example:

-u user:Password

Authenticates the request with the user’s credentials.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs/stats/count"

The endpoint of the request.

from=2019-06-04T00:00:00Z

Date and time. The total statistics after this time will be retrieved.

to=2019-06-06T00:00:00Z

Date and time. The total statistics before this time will be retrieved.

ReadyAPI

  1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do that.

    Tip

    You can also create the needed request from scratch.

  2. Select the GET request to the /api/v1/testjobs/stats/count resource:

    Get total TestEngine usage statistics: Select a request

  3. Specify the time frame for which you want to get the statistics:

    Get total TestEngine usage statistics: Enter the timeframe

  4. Open the Auth panel.

  5. Select the Basic (Built-in) authorization type.

    Tip

    If you use the same credentials in several requests, use authorization profiles.

  6. Specify user credentials and select the Authenticate pre-emptively option:

    Get peak TestEngine usage statistics: Add authorization

  7. Send the request:

    Get total TestEngine usage statistics: Send the request

  8. The response will show statistics for the specified period of time grouped by hours:

    Get TestEngine peak usage: View the response

Using Web UI

  1. Go to the home page of TestEngine:

    http://<testengine-host>:<port>/

    For example, if TestEngine is installed on your local machine and you run it on the default port, use the following link:

    http://localhost:8080/

  2. Go to Statistics:

    Test jobs statistics

The bottom graph shows the total number of the run and queued test jobs for the specified period of time. To select another time period, use the controls in the top-left corner:

TestEngine Statistics: Select time period

Get current usage

To learn how many tests are running or in a queue at the moment, do the following:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/current

Authentication

The request must be authenticated by a TestEngine user.

Example
curl

Use the following command line:

curl -u "user:Password" -X GET "http://localhost:8080/api/v1/testjobs/stats/current"

In this example:

-u user:Password

Authenticates the request with the user’s credentials.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs/stats/current"

The endpoint of the request.

ReadyAPI

  1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do that.

    Tip

    You can also create the needed request from scratch.

  2. Select the GET request to the /api/v1/testjobs/stats/current resource:

    Get info on current test jobs: Select a request

  3. Open the Auth panel.

  4. Select the Basic (Built-in) authorization type.

    Tip

    If you use the same credentials in several requests, use authorization profiles.

  5. Specify user credentials and select the Authenticate pre-emptively option:

    Get peak TestEngine usage statistics: Add authorization

  6. Send the request and analyze the response:

    get-current-testjobs-response.png

Get waiting time

To get information on how long test jobs were in a queue (in milliseconds), run the following command:

GET  http://<testengine-host>:8080/api/v1/testjobs/stats/wait[?from=date][&to=date]

from

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, TestEngine returns the waiting time of the test jobs that were sent after this date and time.

Tip

Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

to

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, TestEngine returns the waiting time of the test jobs that were sent before this date and time.

Tip

Z indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

Authentication

The request must be authenticated by a TestEngine user.

Example
curl

Use the following command line:

curl -u "user:Password" -X GET "http://localhost:8080/api/v1/testjobs/stats/wait?from=2019-07-04T00:00:00Z&to=2019-07-06T00:00:00Z"

In this example:

-u user:Password

Authenticates the request with the user’s credentials.

-X GET

Specifies the GET method.

"http://localhost:8080/api/v1/testjobs/stats/wait"

The endpoint of the request.

from=2019-07-04T00:00:00Z

Date and time. The waiting time will be calculated using the test jobs sent after this time.

to=2019-07-06T00:00:00Z

Date and time. The waiting time will be calculated using test jobs sent before this time.

ReadyAPI

  1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do that.

    Tip

    You can also create the needed request from scratch.

  2. Select the GET request to the /api/v1/testjobs/stats/wait resource:

    Get info on current test jobs: Select a request

  3. Specify the time frame for which you want the waiting time to be calculated:

    Get wait time: Enter the timeframe

  4. Open the Auth panel.

  5. Select the Basic (Built-in) authorization type.

    Tip

    If you use the same credentials in several requests, use authorization profiles.

  6. Specify user credentials and select the Authenticate pre-emptively option:

    Get peak TestEngine usage statistics: Add authorization

  7. Send the request:

    Get total TestEngine usage statistics: Send the request

  8. The response will show the maximum and average waiting time of test jobs for the specified time frame:

    get-wait-time-response.png

See Also

In this section:
© 2025
Publication date: