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

Obtaining information about usage per user for a feature

You can easily fetch metrics about usage per user by sending one of the following HTTP requests.

Usage per user for a single feature
 GET /api/v1/report/feature/${featureId}/usage-per-user/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&grat=${granularity}$(additional parameters, as needed)


Usage per user for a single license server
 GET /api/v1/report/license-server/${licenseServerId}/usage-per-user/${returnType}?sd=${YYYY-MM-DD}&ed=${YYYY-MM-DD}&grat=${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}Yesinteger

Internal License Statistics identification of the feature for which you want to view usage history.

${licenseServerId}Yesinteger/string

Internal License Statistics identification of the license server for which you want to view usage history, or "all" if information about all license servers is requested.

${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.
gratYesenumeration

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

agrtNointeger

Type of aggregation of the returned data. Aggregation type can be one of the following:

  • Username - 1
  • Hostname - 2
  • Username and hostname - 3
  • Usergroup - 4
  • Hostgroup - 5

By default, data is aggregated by username and hostname (3).

standard report optionsNovarious

See Making an API request for details.

Response

On success, this report will contain one row for each feature for each aggregator for each period. Each row consists of the following columns.


ColumnFull nameTypeDescriptionVisible by default in export
fudDatestring

The time period. Format depends on granularity.

Yes
uidUser IDstring

Internal License Statistics identification of the user for aggregations Username(1) and Username and hostname(3).

Otherwise, a semicolon-separated list of user IDs.

Error (x) Unavailable
unUsernamestring

Name of the user for aggregations Username(1) and Username and hostname(3).

Otherwise, a semicolon-separated list of usernames.

Yes
uilUser is from LDAPstring

Information about whether the user is managed by LDAP for aggregations Username(1) and Username and hostname(3).

Otherwise, a null value.

Error (x) Unavailable
ugnUser Groupstring

Name of user group for aggregations Usergroup(4).

Otherwise, an empty string.

(warning) Only for aggregation Usergroup(4)
hnHostnamestring

Hostname for aggregations Hostname(2) and Username and hostname(3).


Otherwise, a semicolon-separated list of hostnames.

Yes
hgnHost GroupstringName of host group for aggregations Hostgroup(5).

Otherwise, an empty string.

(warning) Only for aggregation Hostgroup(4)
lsidLicense Server IDintegerInternal License Statistics identification of the license server hosting the feature.
Error (x) Unavailable
lsnLicense ServerstringName of the license server hosting the feature. Yes
fidFeature IDintegerInternal License Statistics identification of the feature.
Error (x) Unavailable
fnsFeature NamestringFeature name.
Yes
fvFeature VersionstringFeature version. Yes
ftypeFeature TypeenumerationSee feature type descriptions for details. Yes
musageMax UsagefloatMaximum usage of licenses in relation to total number of licenses in the period, expressed in percentages. Yes
huHours UsedfloatCumulative time used by all licenses of the feature in the period, in hours. Yes
muMax UsedintegerMaximum number of licenses of the feature used in the period.
Yes
hbHours BorrowedfloatCumulative time of all license borrows of the feature in the period, in hours.
Yes
mbMax BorrowedintegerMaximum number of licenses of the feature borrowed in the period.
Yes

Note that the order in the table is the default order of the columns in the exported file.