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
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/users/current/${returnType} |
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
Parameter | Required | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xls or pdf. | ||||||||||
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
where number "1" indicates that a specific field is visible. Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here. | ||||||||||
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored. If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty. | ||||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter by a string column, use the following format:
To filter by a numeric column, use the following format:
| ||||||||||
| limit | No | integer | Determines the maximum number of data records that can be returned. The value must be greater than zero. | ||||||||||
| offset | No | integer | Specifies the offset of the first row to return. | ||||||||||
| orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: fid, fns, fv, ftype, lsid, lsn, uid, un, hn, lco, lus (See this section for more field-specific information.) | ||||||||||
| orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. |
Response
The following code block shows an example result of a successful request.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"ftype": ${featureType},
"fv": ${featureVersion},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"uid": ${userId},
"un": ${userName},
"hn": ${hostName},
"lco": ${licenseCheckedOut},
"lus": ${licensesUsed}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
| Anchor | ||||
|---|---|---|---|---|
|
...
You can filter your data results using the filter parameter, as described above.
Response
The following code block shows an example result of a successful request.
| Code Block | ||
|---|---|---|
| ||
{
"success": ${success},
"msg": ${message},
"data": [
{
"hu": 1,
"tu": ${usersWithLicensesCount}
},
{
"hu": 0,
"tu": ${usersWithoutLicensesCount}
}
],
"code": ${code},
"totalCount": 2
} |
...
Say you have many license servers, some of which are LM-X servers called 'lm-x 1', 'lm-x 2', etc. To find out The following example shows a command that lets you identify how many users are using licenses (only) from those servers, enter a command similar to the followingparticular servers.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --globoff -H "X-Auth-token: token" 'http://yourdomain/api/v1/report/users/license/current-usage/json?filter=[{"type":"string","field":"lsn","value":"lm-x"}]' |
...
You can filter your data results using the filter parameter, as described above.
Response
The following code block shows an example result of a successful request.
...
Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether your API request was successfully processed. |
| msg | string | Error message returned on failure. |
| un | string | Username. |
| lus | integer | Number fo licenses used. |
| code | integer | Error code if success equals false, null otherwise. |
| totalCount | integer | Total number of rows returned. Up to 10. |
Example
Say you have a feature called 'super_feature' and you would like to The following example shows a command that lets you obtain information about users that use this feature have the highest usage of a feature named "super_feature" (in any version) most. To generate this data set, enter a command similar to the following.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --globoff -H "X-Auth-token: token" 'http://yourdomain/api/v1/report/users/license/highest-usage/json?filter=[{"type":"string","field":"fns","value":"super_feature"}]' |
...