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.
Code Block |
---|
language | js |
---|
firstline | 1 |
---|
title | Usage history for a single feature |
---|
|
GET /api/v1/report/feature/${featureId}/usage-history/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed) |
Usage History for Feature
...
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 |
---|
|
GET /api/v1/report/feature-comparison/${ucompi}/report/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&granularity=${granularity} |
Code Block |
---|
language | js |
---|
firstline | 1 |
---|
title | Usage history for a license server |
---|
|
GET /api/v1/report/license-server/${lsid}/usage-history//${featureId}/${returnType}?sd=${startDateYYYY-MM-DD}&ed={endDateYYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed) |
...
where:
title | Usage history for a license server group |
---|
|
GET /api/v1/report/license-server-group/${lsgid}/usage-history/${returnType}?sd=${YYYY-MM-DD}&ed={YYYY-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:a value that best suits your needs. The possible parameters are described below.
Parameter | Required | Type | Description |
---|
${featureId} | Yes | integer | Internal License Statistics identification of the feature to show usage history for. |
${fcid} | Yes | integer |
Specifies feature-specific parametersInternal 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 | Internal 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 |
stringSpecifies the start Start date for which the report will be generated |
in YYYY-MM-DD format; for example, 2016-01-20stringSpecifies the end End date for which the report will be generated |
in YYYY-MM-DD format; for example, 2016-01-27integer | Specifies granularity of the returned data; Can be one of the following: - quarter - 2
- month - 3
- week - 4
- day - 5
- hour - 6
| filter | No | json/string | |
fieldsVisibility | No | json/string | 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.
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: enumeration | Period type the result is aggregated for. See granularity descriptions for further details. |
standard report options | No | various | |
Response
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.