The Current Utilization endpoint delivers license usage metrics specific to the Current Utilization.
Obtaining information about current feature utilization
You can easily fetch metrics about current feature usage for a given feature by sending the following HTTP request.
GET /api/v1/report/current-utilization/${returnType}
where $ indicates a variable value that you can replace with a value that best suits your needs and the possible parameters can be explained as follows.
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, xslx 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. It works with every 'returnType' other than 'json'. | |
| 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: [
{
"type": "string",
"field": "${fns | ftype | fv | lsn | vn}",
"value": "${value}"
}
]
To filter by a numeric column, use the following format: [
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | ft | fu | futil | ig | lsid}",
"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: fid, fns, ft, ftype, fu, futil, fv, ig, lsid, lsn, vn | |
| orderDirection | No | string | Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order. |
The following code block shows an example result of a successful request.
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"ft": ${featureTotal},
"ftype": ${featureType},
"fu": ${licensesUsed},
"futil": ${featureUtilization},
"fv": ${featureVersion},
"ig": ${isGrouped},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"vn": ${vendorName}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
}
where the response fields can be explained as follows:
Field | Type | Description |
|---|---|---|
fid | integer | Feature ID |
fns | string | Feature name. |
ft | integer | Total amount of licenses. |
ftype | string | Type of feature |
fu | integer | Amount of used licenses |
futil | decimal | Percentage of used licenses (used/total) |
| fv | string | Version of the feature |
ig | integer | If '1' then row represents group of features if '0' then single feature. Info about groups: License server groups |
| lsid | integer | License server id |
| lsn | string | License server name |
| vn | string | Vendor name |
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 this report in csv format . To generate this data set, enter a command similar to the following.
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-utilization/csv"