The Current Usage endpoint delivers current license usage metrics, as detailed below.
Obtaining information about usage on multiple hosts (Current Usage On Multiple Hosts report)
You can easily list users that are using licenses on multiple hosts by sending the following HTTP request.
GET /api/v1/report/current-usage/on-multiple-hosts/${returnType}?(parameters, as needed)
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 for details. |
| standard report options | No | various | See Making an API request for details. |
Response
On success, this report will contain one row for each feature-user pair, where user has checked out licenses of feature on multiple hosts. Each row consists of the following columns.
| Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| fid | Feature Id | integer | Internal License Statistics identification of the feature. |  No |
| fns | Feature Name | string | Name of feature. |  Yes |
| fv | Feature Version | string | Feature version. | Yes |
| ftype | Feature Type | enumeration | See feature type descriptions for details. | Yes |
| vn | Vendor | string | Name of license server vendor hosting the feature. | Yes |
| lsid | License Server Id | integer | Internal identification of license server hosting the feature. | No |
| lsn | License Server | string | Name of license server hosting the feature. | Yes |
| uid | User Id | integer | Internal License Statistics identification of the user. | No |
| un | User | string | User name. | Yes |
| hl | Hosts | string | List of hosts on which the user has checked out licenses of the feature, separated by a semicolon (;). | Yes |
| uil | User is from LDAP | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. |  Unavailable |
Note that the order in the table is the default order of the columns in the exported file.
Example
The following example shows a command that obtains information about users using features on multiple hosts.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/on-multiple-hosts/json"
Obtaining information about usage above/below n hours (report Current Usage By Time Range)
You can easily list data about features currently in use for more/less than n hours by sending the following HTTP request
GET /api/v1/report/current-usage/by-time-range/${returnType}?ab=${integer}&bl=${integer}&(additional parameters, as needed)
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 for details. |
| ab | No | integer | Minimum number of hours a license has to be used to be listed. If not provided constraint not imposed. |
| bl | No | integer | Maximum number of hours a license has to be used to be listed. If not provided, this constraint is not imposed. Value must be greater than value of 'ab' parameter. |
| standard report options | No | various | See Making an API request for details. |
Response
On success, this report will contain one row for each license session, with length within specified range. Each row consists of the following columns.
Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| fid | Feature ID | integer | Internal License Statistics identification of the used feature. | No |
| 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 |
vn | Vendor | string | Name license server vendor hosting the used feature. | Yes |
| lsid | License Server Id | integer | Internal License Statistics identification of license server hosting the used feature. | No |
| lsn | License Server | string | Name of license server hosting the used feature. | Yes |
| uid | User Id | integer | Internal License Statistics identification of user that checked out licenses. | No |
un | User | string | Name of user that checked out licenses. | Yes |
hn | Host | string | Host on which licenses were checked out. | Yes |
lus | Used | integer | Total number of licenses used by user on host. | Yes |
tu | Time Used | string | Indicates how long licenses have been in use; e.g., 1d 2h 10 min. Note that you cannot filter on this field. | Yes |
uil | User is from LDAP | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. | Unavailable |
Note that the order in the table is the default order of the columns in the exported file.
Example
The following example shows a command that downloads data in CSV format about features currently in use for at least 24 hours.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-usage/by-time-range/csv?ab=24"