Page History

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

Anchor
obtain obtain

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.

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:

[{"value": intOrString, "field": "${lud | lumin | lua | lumax | lbmin | lbmax | ldtc | hu | ft}"}]

...

Specifies field visibility settings, for example:

{"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.

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.

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.

...

If your request is successful, you should see a response similar to the following:

{
  "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.

GET /api/v1/report/usage-history/comparison/json?fi=${featureIds}&sd=${startDate}&ed=${endDate}&granularity=${granularity}

...