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. |
License Statistics API allows you to generate data from the The Usage Per User endpoint delivers license usage metrics specific to the Usage Per User report . This report shows statistics for license usage by users on hosts, during any period that usage was trackedfor selected types of aggregation (user, host, user and host, usergroup, hostgroup) over a given time period.
Obtaining information about usage per user for a feature Anchor obtain obtain
obtain | |
obtain |
If you want to retrieve information You can easily fetch metrics about usage per user for a single feature, we recommend that you use the following URL request templateby sending one of the following HTTP requests.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
GET /api/v1/report/feature/${featureId}/usage-per-user/${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&grat=${granularity}$(additional parameters, as needed) |
where
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/v1/report/license-server/${licenseServerId}/usage-per-user/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&grat=${granularity}$(additional parameters, as needed) |
where $ - $ indicates a variable value that you can replace with a proper value, according to your needs
- value that best suits your needs. 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:
- Quarter - 2
- Month - 3
- Week - 4
- Day - 5
- Hour - 6
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.
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 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 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.
If your request is successful, you should see a response similar to the following:
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}
} |
where the response fields can be explained as follows:
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 | Information about whether the user is managed by LDAP for aggregations User(1) and User and host(3). Otherwise, a null value. | Unavailable |
ugn | User Group | string | Name of user group 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 semicolon-separated list of hostnames. | Yes |
hgn | Host Group | string | Name of host group 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 Name | string | Feature name. | Yes |
fv | Feature Version | string | Feature version. | Yes |
ftype | Feature Type | enumeration | See feature type descriptions for details. | Yes |
musage | Max Usage | |||
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 if 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 aggregation type. | ||
ugn | string | Name of user group. Field is only returned when requested aggregation type was usergroup. | ||
hn | string | Hostname or semicolon-separated list of hostnames, depending on aggregation type. | ||
hgn | string | Name of host group. Field is only returned when requested aggregation type was hostgroup. | ||
lsn | string | License server name. | ||
fns | string | Feature name. | ||
fv | string | Feature version. | ||
ftype | string | Feature type. | ||
musage | 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 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 license server
If you want to retrieve information about usage per user for license servers 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 proper value, according to your needs
- possible parameters are as follows:
...
ID of 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, which 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.
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 any column use format specified in previous section.
...
Specifies field visibility settings. In order to do so use format specified in previous section.
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 specified in previous section.
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
...
.