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 History endpoint delivers license usage metrics specific to the Usage History report, allowing you to monitor statistics for license usage during any period that usage was tracked.
Obtaining information about usage history
You can easily fetch metrics about usage history by sending one of the the following HTTP requests
Usage History for Feature
If you want to obtain information about usage history for single feature, you have to use following URL request template.
Code Block |
---|
language | js |
---|
firstline | 1 |
---|
title | Usage history for a single feature |
---|
|
GET /api/v1/report/usage-history/feature/${featureId}/usage-history/${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed) |
where:
- $ indicates a variable value that you can replace with an appropriate value, as needed
- the possible parameters are as follows:
...
Specifies granularity of the returned data; Can be one of the following:
- quarter - 2
- month - 3
- week - 4
- day - 5
- hour - 6
...
Applies filtering license usage data on all fields. To filter your data, use the following format:
Code Block |
---|
|
[{"value": intOrString, "field": "${lud | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft}"}] |
...
Specifies field visibility settings, for example:
Code Block |
---|
|
{"lud": "1", "lumin": "1", "lua": "1", "lumax": "1", "lbmin": "1", "lbmax": "1", "ldtc": "1", "hu": "1", "ft": "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.
Code Block |
---|
language | js |
---|
firstline | 1 |
---|
title | Usage history for a composite feature on license server group |
---|
|
GET /api/v1/report/feature-composite/${fcid}/usage-history/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed) |
Code Block |
---|
language | js |
---|
firstline | 1 |
---|
title | Usage history comparison for features |
---|
|
...
If your request is successful, you should see a response similar to the following:
Code Block |
---|
|
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
where the response fields can be explained as follows:
...
ldtc
...
Usage History for Feature Comparison
If you want to obtain information about usage history for feature comparison, you have to use following URL request template.
Code Block |
---|
|
GET /api/v1/report/usage-history/comparison/json?fi=${featureIds}&feature-comparison/${ucompi}/report/${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&granularity=${granularity} |
The possible parameters are as follows:
...
Code Block |
---|
language | js |
---|
firstline | 1 |
---|
title | Usage history for a license server |
---|
|
GET /api/v1/report/license-server/${lsid}/usage-history/${returnType}?sd=${YYYY-MM-DD}&ed={YYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed) |
Code Block |
---|
title | Usage history for a license server group |
---|
|
Currently this report is returned only in json. There are plans to introduce csv, xls and pdf formats in future.
If your request is successful, you should see a response similar to the following:
Code Block |
---|
|
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId_1},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
},
{
"fid": ${featureId_2},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
The meaning of all fields are the same as in Usage History For Feature.
Usage History for License Server
If you want to obtain information about usage history for all visible features for given server, you have to use following URL request template.
Code Block |
---|
|
GET /api/v1/report/usage-history/license-server-group/${lsidlsgid}/usage-history/${returnType}?sd=${startDateYYYY-MM-DD}&ed={endDateYYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed) |
where $ indicates a variable value that you can replace with a 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 to show usage history for. |
${fcid} | Yes | integer | Internal License Statistics identification of the feature composite to show usage history for. |
${ucompi} | Yes | integer | Internal License Statistics identification of feature history comparison. |
${lsid} | Yes | integer |
License Server IdInternal License Statistics identification of the license server to show usage history for. |
${ |
returnTypestring | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdfinteger | Internal License Statistics identification of the license server group to show usage history for. |
${returnType} | Yes | string | Standard format option. See Making an API request for details.
|
sd | Yes |
string | See Usage History For Featuredate | Start date for which the report will be generated. |
ed | Yes |
string | date | End date for which the report will be generated |
See Usage History For Featureinteger | See Usage History For Feature. | rnenumeration | Period type the result is aggregated for. See granularity descriptions for further details. |
standard report options | No |
string | See Usage History For Feature. | filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
Code Block |
---|
|
[{"value": intOrString, "field": "${}"}] |
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
limit | No | integer | See Usage History For Feature. |
offset | No | integer | See Usage History For Feature. |
orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: |
orderDirection | No | string | See Usage History For FeatureResponse
On success, this report will contain one row for every feature and every period in which the feature was monitored. Each row consists of the following columns.
Note that the order in the table is the default order of the columns in the exported file for the license server and license server group reports. For feature, feature composite and comparison default order is: fn, fns, fv, lud, lumin, lua, lumax, lbmin, lbmax, ft, hu, ldtc.