The Current Feature Usage endpoint delivers license usage metrics specific to the Current Feature Usage, allowing you to monitor statistics for the currently selected feature on the license server of your choosing.
Obtaining information about current feature usage
You can easily fetch metrics about current feature usage for a given feature by sending the following HTTP request.
GET /api/v1/report/feature/${featureId}/current-usage/${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 |
---|---|---|---|
${featureId} | Yes | integer/string | Specifies ID of the feature for which you want to view current usage. |
${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xlsx, or pdf. |
fieldsVisibility | No | json/string | Specifies field visibility settings, for example: { "uid": "1", "un": "1", "hn": "1", "lus": "1", "lco": "1", "tu": "1", "lbe": "1" } 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 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 XLSX 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: [ { "type": "string", "field": "${un | hn | lco | lbe}", "value": "${value}" } ] To filter by a numeric column, use the following format: [ { "type": "numeric", "comparison": "${gt | lt | eq}", "field": "${uid, lus}", "value": "${value}" } ] |
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: uid, un, hn, lus, lco, tu, lbe (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.
{ success: ${success}, msg: ${message}, data: [{ "uid": ${userId}, "un": ${userName}, "hn": ${hostName}, "lus": ${licensesUsed}, "lco": ${checkoutTime}, "tu": ${licensesUsed}, "lbe": ${borrowExpire}, "uil": ${ldapUser} }], "code": ${errorCode}, "totalCount": ${totalCount} }
where the response fields can be explained as follows:
Field | Type | Description |
---|---|---|
uid | integer | User ID. |
un | string | Username. |
hn | string | Hostname. |
lus | integer | Total number of licenses used by user on host. |
lco | string | Date when license was checked out. The date is in YYYY-MM-DD HH:MM format; for example, 2017-05-20 10:20. |
lbe | string | Borrow expiration date. The date is in YYYY-MM-DD HH:MM format; for example, 2017-05-20 10:20. Returns an empty string if does not apply. |
tu | string | Indicates how long this license has been in use. Note that you cannot filter on this field |
uil | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. |
msg | string | Error message returned on failure. |
success | boolean | Indicates whether your API request was successfully processed. |
code | integer | Error code for an unsuccessful request. |
totalCount | integer | Total number of all matching results. |
Example
Say you would like to download data in a CSV file about current feature usage for feature "1". To generate this data set, enter a command similar to the following.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/1/current-usage/csv"
Obtaining information about feature usage during given day
You can easily fetch metrics about feature usage during a given day by sending the following HTTP request.
GET /api/v1/report/feature/${featureId}/usage/chart/json?day=${day}
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 |
---|---|---|---|
${featureId} | Yes | integer | ID of the feature for which you want to get data. |
${day} | No | string | Date in YYYY-MM-DD format. Indicates day for which you want to gather data. If not provided, it defaults to today. |
Response
The following code block shows an example result of a successful request.
{ success: ${success}, msg: ${message}, data: [{ "fid": ${featureId}, "lud": ${dateAndTime}, "ltc": ${totalCount}, "lumax": ${licenseUsageMax}, "lbmax": ${licensesBorrowedMax} }], "code": ${errorCode}, "totalCount": ${totalCount} }
where the response fields can be explained as follows:
Field | Type | Description |
---|---|---|
fid | integer | Feature ID. |
lud | string | Date and time (adjusted to 5 minute intervals). |
ltc | integer | License total count. |
lumax | integer | Maximum amount of used licenses. |
lbmax | integer | Maximum amount of borrowed licenses. |
msg | string | Error message returned on failure. |
success | boolean | Indicates whether the API request was successfully processed. |
code | integer | Error code for unsuccessful request. |
totalCount | integer | Total number of all matching results. |