Page tree
Skip to end of metadata
Go to start of metadata

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 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 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)

Usage history comparison for features
GET /api/v1/report/feature-comparison/${ucompi}/report/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&granularity=${granularity}
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)


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 a value that best suits your needs. The possible parameters are described below.

ParameterRequiredTypeDescription
${featureId}YesintegerInternal License Statistics identification of the feature to show usage history for.
${fcid}YesintegerInternal License Statistics identification of the feature composite to show usage history for.
${ucompi}YesintegerInternal License Statistics identification of feature history comparison.
${lsid}YesintegerInternal License Statistics identification of the license server to show usage history for.
${lsgid}YesintegerInternal License Statistics identification of the license server group to show usage history for.
${returnType}YesstringStandard format option. See Making an API request for details.
sdYesdateStart date for which the report will be generated.
edYesdateEnd date for which the report will be generated.
granularityYesenumeration

Period type the result is aggregated for. See granularity descriptions for further details.

standard report optionsNovarious

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.

ColumnFull nameTypeDescriptionVisible by default in export
ludDatestring

The time period. Format depends on granularity.

Yes
fidFeature IdintegerInternal License Statistics identification of the feature(minus) No
fnsFeature NamestringFeature name.(warning) Visible for all, but feature
fvFeature VersionstringFeature version.(warning) Visible for all, but feature
ftypeFeature TypeenumerationSee feature type descriptions for details.(warning) Visible for all, but feature
luminMin UsedintegerMinimal number of licenses of the feature used in the period. Yes
luaAvg UsedfloatAverage number of licenses of the feature used in the period. Yes
lumaxMax UsedintegerMaximum number of licenses of the feature used in the period. Yes
lbminMin BorrowedintegerMinimal number of licenses of the feature borrowed in the period. Yes
lbmaxMax BorrowedintegerMaximum number of licenses of the feature borrowed in the period. Yes
ftTotalintegerTotal number of licenses of the feature available in period. Yes
huHours UsedfloatCumulative time used by all licenses of the feature in the period, in hours. Yes

ldtc

DenialsintegerNumber 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.