Warning |
---|
This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
The Usage Per User endpoint delivers metrics that License Statistics collects from the monitored license server. This endpoint is used to fetch license usage metrics specific to the Usage Per User report , for selected type types of aggregation (usernameuser, hostnamehost, username user and hostnamehost, usergroup, hostgroup) , over a given timeframetime period.
Obtaining information about usage per user for a feature Anchorobtain obtain
obtain | |
obtain |
If you want to You can easily fetch metrics about usage per user by sending one of the following HTTP requests.
Code Block | ||||||
---|---|---|---|---|---|---|
|
...
GET /api/v1/report/feature/${featureId}/usage-per-user/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&grat=${granularity}$(additional parameters, as needed) |
...
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
GET /api/v1/report/featurelicense-server/${featureIdlicenseServerId}/usage-per-user/${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&grat=${granularity}$(additional parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters are as follows:described below.
Parameter | Required | Type | Description |
---|---|---|---|
${featureId} | Yes | integer |
Internal License Statistics identification of the feature for which you want to view usage history. |
${ |
licenseServerId} | Yes | integer/string |
Internal License Statistics identification of the license server for which you want to view usage history, or "all" if information about all license servers is requested. | |||
${returnType} | Yes | string | Standard format option. See Making an API request for details. |
sd | Yes |
date |
Start date for which the report will be generated |
. | |
ed | Yes |
date |
End date for which the report will be generated |
. | |
grat | Yes |
Specifies granularity of the returned data, which can be one of the following:
enumeration | Period type the result is aggregated for. HOUR granularity is not supported. See granularity descriptions for further details. | |
agrt | No | integer |
Type of aggregation of the returned data. Aggregation type can be one of the following: |
|
|
|
By default, data is aggregated by |
user and host (3). |
standard report options | No |
Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS/XLSX. For CSV and JSON formats this parameter will be ignored.
Note: If you don't pass this parameter, it will be generated automatically for PDF and XLS/XLSX types. If provided, it cannot be left empty.
Applies filtering license usage data on all fields.
To filter by a string column, use the following format:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"type": "string",
"field": ""${fud | un | ugn | hn | hgn | lsn | fns | fv | ftype}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${musage | hu | mu | hb | mb}",
"value": "${value}"
}
] |
Specifies field visibility settings, like this:
Code Block | ||||
---|---|---|---|---|
| ||||
{
"fud": "1",
"un": "1",
"ugn": "1",
"hn": "1",
"hgn": "1",
"lsn": "1",
"fns": "1",
"fv": "1",
"ftype": "1",
"musage": "1",
"hu": "1",
"mu": "1",
"hb": "1",
"mb": "1"
} |
where "1" indicates that a specific field is visible and ''0" indicates that it is not.
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.
Specifies the field by which you want to order your data records. The field name can be one of the following:
fud | un | ugn | hn | hgn | lsn | fns | fv | ftype | musage | hu | mu | hb | mb
If orderBy is provided, orderDirection is mandatory.
...
Code Block | ||||
---|---|---|---|---|
| ||||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId},
"lsid": ${licenseServerId},
"uid": ${userId},
"uil": ${userIsLdap},
"fud": ${date},
"un": ${username},
"ugn": ${userGroupName},
"hn": ${hostname},
"hgn": ${hostGroupName},
"lsn": ${licenseServerName},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"musage": ${maxUsage},
"hu": ${hoursUsed},
"mu": ${maxUsed},
"hb": ${hoursBorrowed},
"mb": ${maxBorrowed}
}
],
"code": ${code},
"totalCount": ${count}
} |
...
various | See Making an API request for details. |
Response
On success, this report will contain one row for each feature for each aggregator for each period. Each row consists of the following columns.
Column | Full name | Type | Description | Visible by default in export |
---|---|---|---|---|
fud | Date | string | The time period. Format depends on granularity. | Yes |
uid | User ID | string | Internal License Statistics identification of the user for aggregations User(1) and User and Host(3). Otherwise, a semicolon-separated list of user IDs. | Unavailable |
un | User | string | Name of the user for aggregations User(1) and User and host(3). Otherwise, a semicolon-separated list of usernames. | Yes |
uil | User is from LDAP | string |
...
Field | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
success | boolean | Indicates that your API request was successfully processed. | ||||||
msg | string | Error message returned on failure. | ||||||
fid | integer | Feature ID. | ||||||
lsid | integer | License server ID. | ||||||
uid | integer | User ID. | ||||||
uil | boolean | Information about whether the user is managed by LDAP | .||||||
fud | string | Indicates period of time for which usage information is generated, i.e. date and time for hourly usage and dates for the remaining granularity options. | ||||||
un | string | Username or semicolon-separated list of usernames, depending on the aggregation type. | ||||||
for aggregations User(1) and User and host(3). Otherwise, a null value. | Unavailable | |||||||
ugn | User Group | ugnstring | Name of user group | . This field is returned only when the requested aggregation type was usergroup.for aggregations Usergroup(4). Otherwise, an empty string. | Only for aggregation Usergroup(4) | |||
hn | Host | string | Hostname for aggregations Host(2) and User and host(3). Otherwise, a | hn | string | Hostname orsemicolon-separated list of | hostnames, depending on aggregation typehostnames. | Yes |
hgn | Host Group | string | Name of host group | . This field is returned only when requested aggregation type was hostgroup.|||||
lsn | string | License server name. | ||||||
for aggregations Hostgroup(5). Otherwise, an empty string. | Only for aggregation Hostgroup(4) | |||||||
lsid | License Server ID | integer | Internal License Statistics identification of the license server hosting the feature. | Unavailable | ||||
lsn | License Server | string | Name of the license server hosting the feature. | Yes | ||||
fid | Feature ID | integer | Internal License Statistics identification of the feature. | Unavailable | ||||
fns | Feature Namefns | string | Feature name. | Yes | ||||
fv | Feature Version | string | Feature version. | Yes | ||||
ftype | Feature Type | stringenumeration | Feature See feature type descriptions for details. | Yes | ||||
musage | Max Usage | float | Maximum usage of licenses in relation to total license number of licenses in the period, expressed in percentages. | Yes | ||||
hu | Hours Used | float | Hours used. | |||||
mu | integer | Maximum licenses used count for given date. | ||||||
hb | float | Hours borrowed. | ||||||
mb | integer | Maximum licenses borrowed count for a given date. | ||||||
code | integer | Error code if success equals false, null otherwise. | ||||||
totalCount | integer | Total number of rows returned. |
Obtaining information about usage per user for a license server
If you want to fetch metrics about usage per user for a single license server, we recommend that you use the following URL request template.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/license-server/${licenseServerId}/usage-per-user/${returnType}?sd=${startDate}&ed=${endDate}&grat=${granularity}$(additional parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs and the possible parameters are as follows:
...
ID of a single license server or "all" if information about all license servers is requested.
...
Specifies granularity of the returned data, which can be one of the following:
- Quarter - 2
- Month - 3
- Week - 4
- Day - 5
- Hour - 6
...
Specifies aggregation type of the returned data. Aggregation type can be one of the following:
- Username - 1
- Hostname - 2
- Username and hostname - 3
- Usergroup - 4
- Hostgroup - 5
By default data is aggregated by username and hostname.
...
No
...
Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS/XLSX. For CSV and JSON formats this parameter will be ignored.
Note: If you don't pass this parameter, it will be generated automatically for PDF and XLS/XLSX types. If provided, it cannot be left empty.
...
Applies filtering license usage data on all fields. (See the section above for more format-specific information.)
...
Specifies field visibility settings. (See the section above for more information.)
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.
...
Specifies the field by which you want to order your data records. The field name can be one of the following:
fud | un | ugn | hn | hgn | lsn | fns | fv | ftype | musage | hu | mu | hb | mb
(See the section above for more field-specific information.)
If orderBy is provided, orderDirection is mandatory.
...
Cumulative time used by all licenses of the feature in the period, in hours. | Yes | |||
mu | Max Used | integer | Maximum number of licenses of the feature used in the period. | Yes |
hb | Hours Borrowed | float | Cumulative time of all license borrows of the feature in the period, in hours. | Yes |
mb | Max Borrowed | integer | Maximum number of licenses of the feature borrowed in the period. | Yes |
Note that the order in the table is the default order of the columns in the exported file
...
.