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.
GET /api/v1/report/feature/${featureId}/usage-history/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed)
GET /api/v1/report/feature-composite/${fcid}/usage-history/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed)
GET /api/v1/report/feature-comparison/${ucompi}/report/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&granularity=${granularity}
GET /api/v1/report/license-server/${lsid}/usage-history/${returnType}?sd=${YYYY-MM-DD}&ed={YYYY-MM-DD}&granularity=${granularity}$(additional parameters, as needed)
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 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 | 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 | Internal License Statistics identification of the license server to show usage history for. |
| ${lsgid} | Yes | integer | 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 | date | Start date for which the report will be generated. |
| ed | Yes | date | End date for which the report will be generated. |
| granularity | Yes | enumeration | Period type the result is aggregated for. See granularity descriptions for further details. |
| standard report options | No | various | See Making an API request for details. |
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.
| Column | Full name | Type | Description | Visible by default in export |
|---|---|---|---|---|
| lud | Date | string | The time period. Format depends on granularity. |  Yes |
| fid | Feature Id | integer | Internal License Statistics identification of the feature |  No |
| fns | Feature Name | string | Feature name. |  Visible for all, but feature |
| fv | Feature Version | string | Feature version. | Visible for all, but feature |
| ftype | Feature Type | enumeration | See feature type descriptions for details. | Visible for all, but feature |
| lumin | Min Used | integer | Minimal number of licenses of the feature used in the period. | Yes |
| lua | Avg Used | float | Average number of licenses of the feature used in the period. | Yes |
| lumax | Max Used | integer | Maximum number of licenses of the feature used in the period. | Yes |
| lbmin | Min Borrowed | integer | Minimal number of licenses of the feature borrowed in the period. | Yes |
| lbmax | Max Borrowed | integer | Maximum number of licenses of the feature borrowed in the period. | Yes |
| ft | Total | integer | Total number of licenses of the feature available in period. | Yes |
| hu | Hours Used | float | Cumulative time used by all licenses of the feature in the period, in hours. | Yes |
ldtc | Denials | integer | Number of denials of check out of a license of the feature in the period. | Yes |
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.