The Current Users endpoint delivers license usage metrics specific to the Current Users report, allowing you to see currently active users and the features they are using.
Obtaining information about current users
You can easily list users who are currently using at least one license by sending the following HTTP request.
GET /api/v1/report/users/current/${returnType}
where $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.
Parameter | Required | Type | Description |
|---|---|---|---|
| ${returnType} | Yes | string | Standard format option. See Making an API request page for details. |
| standard report options | No | various | Refer to Making an API request page for details. |
Response
On success, this report will contain one row for each license session. Each row consists of the following columns.
Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| uid | User Id | integer | Internal License Statistics identification of user that checked out licenses. |  Yes |
un | User | string | Name of user that checked out licenses. | Yes |
hn | Host | string | Host on which licenses were checked out. | Yes |
| fid | Feature Id | integer | Internal License Statistics identification of the used feature. | Yes |
| fns | Feature Name | string | Name of the used feature. | Yes |
| fv | Feature Version | string | Version of the used feature. | Yes |
| ftype | Feature Type | enumeration | Type of the used feature. See feature type descriptions for further details. | Yes |
lus | Used | integer | Total number of licenses used by user on host. | Yes |
lco | Checked Out | date and time | Time when licenses were checked out. | Yes |
| lsid | License Server Id | integer | Internal License Statistics identification of server hosting the used feature. | Yes |
| lsn | License Server | string | Name of server hosting the used feature. | Yes |
Note that the order in the table is the default order of the columns in the exported file.
Obtaining information about current license usage
You can easily list users that are currently using at least one license by sending the following HTTP request.
GET /api/v1/report/users/license/current-usage/json
This report supports only JSON format.
This report does not support standard options (filtering, limiting or ordering).
Response
On success, the license server will return the following response.
{
"success": true,
"msg": null,
"data": {
"current": ${current},
"licenseUsage": ${licenseUsage},
"licenseLimit": ${licensedUsers}
}
}
Field | Type | Description |
|---|---|---|
| current | integer | Number of users or user-hosts that are currently using any license on any currently monitored license server. |
| licenseUsage | integer | Number of users or user-hosts that are counted for license usage. This value depends on the licensing model. |
| licenseLimit | integer | Number of users or users-hosts that this license server is licensed for. |
Obtaining information about highest license usage
You can easily list the 10 users that are using the highest number of licenses by sending the following HTTP request.
GET /api/v1/report/users/license/highest-usage/json
This report supports only JSON format.
This report does not support standard options (filtering, limiting or ordering).
Response
On success, this report will contain up to 10 rows of information about users with the highest number of checked out licenses. Each row consists of the following columns.
Field | Full name | Type | Description |
|---|---|---|---|
| un | User | string | User name. |
| lus | Used | integer | Number of all licenses used by the user. |