Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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.

...

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 User - 1
  • Hostname Host - 2
  • Username User and hostname host - 3
  • Usergroup - 4
  • Hostgroup - 5

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

standard report optionsNovarious

See Making an API request for details.

...

ColumnFull nameTypeDescriptionVisible by default in export
fudDatestring

The time period. Format depends on granularity.

(tick)Yes
uidUser IDstring

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

Otherwise, a semicolon-separated list of user IDs.

Error (x)(error) Unavailable
unUsernameUserstring

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

Otherwise, a semicolon-separated list of usernames.

(tick)Yes
uilUser is from LDAPstring

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

Otherwise, a null value.

Error (x)(error) Unavailable
ugnUser Groupstring

Name of user group for aggregations Usergroup(4).

Otherwise, an empty string.

(warning) Only for aggregation Usergroup(4)
hnHostnameHoststring

Hostname for aggregations HostnameHost(2) and Username User and hostnamehost(3).

Otherwise, a semicolon-separated list of hostnames.

(tick)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)(error) Unavailable
lsnLicense ServerstringName of the license server hosting the feature.(tick)Yes
fidFeature IDintegerInternal License Statistics identification of the feature.
Error (x)(error) Unavailable
fnsFeature NamestringFeature name.
(tick)Yes
fvFeature VersionstringFeature version.(tick)Yes
ftypeFeature TypeenumerationSee feature type descriptions for details.(tick)Yes
musageMax UsagefloatMaximum usage of licenses in relation to total number of licenses in the period, expressed in percentages.(tick)Yes
huHours UsedfloatCumulative time used by all licenses of the feature in the period, in hours.(tick)Yes
muMax UsedintegerMaximum number of licenses of the feature used in the period.
(tick)Yes
hbHours BorrowedfloatCumulative time of all license borrows of the feature in the period, in hours.
(tick)Yes
mbMax BorrowedintegerMaximum number of licenses of the feature borrowed in the period.
(tick)Yes

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